Agents

Agent volume/units over time with buyer/seller/dual split

POST
/v1/agents/analytics/time-series

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/agents/analytics/time-series" \  -H "Content-Type: application/json" \  -d '{}'
{
  "current": [
    {
      "buyer": {
        "units": 0,
        "volume": 0
      },
      "date": "string",
      "dual": {
        "units": 0,
        "volume": 0
      },
      "seller": {
        "units": 0,
        "volume": 0
      },
      "total": {
        "units": 0,
        "volume": 0
      }
    }
  ],
  "previous": [
    {
      "buyer": {
        "units": 0,
        "volume": 0
      },
      "date": "string",
      "dual": {
        "units": 0,
        "volume": 0
      },
      "seller": {
        "units": 0,
        "volume": 0
      },
      "total": {
        "units": 0,
        "volume": 0
      }
    }
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Production summary with buyer/seller/dual split + previous period POST

Previous Page

Home builders on the agent's deals (pre-aggregated) POST

New-construction builders named on the agent's deals in the period, ranked by units. The pre-aggregated builder list carries a deal COUNT only, so every row's `volume` and `pctVolume` are 0 — rank and share by `units` / `pctUnits` (a share of ALL the agent's deals in the period, so the rows sum to the builder-sold share, not to 1). It carries no buyer/listing split either: `side` must be `any` (or omitted); `buyer`/`listing` return 400.