Skip to content
Dixa API/
/
Query agent records

Query agent records

Request

Query the individual rows of an agent-anchored record. Pagination travels in the request body: echo meta.next back as pagination.pageKey to fetch the following page. No filters means every agent, including deactivated ones.

Security
ApiKeyAuth
Path
recordIdstringrequired

An agent-anchored record id from List Records

Bodyapplication/jsonrequired

The record query: its primary anchor, any secondary filters, the timezone and a page request

primaryFilterAgentPeriodPrimaryFilter (object)(AgentPrimaryFilter)required
One of:

Anchors the query on a time range

filtersArray of objects(SecondaryFilter)

Absent means no secondary filtering

timezonestringrequired

The zone the period is evaluated in; an invalid zone is rejected as a 400

paginationobject(PageRequest)

A request for one page of a paginated query; absent means the first page at the server's default size

includeLabelsboolean

Absent defaults to true; false drops every label but keeps the cell shape

POST
/beta/intelligence/agents/records/{recordId}
curl -i -X POST \
  'https://dev.dixa.io/beta/intelligence/agents/records/{recordId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "primaryFilter": {
      "period": {
        "interval": {
          "from": "2026-06-01T00:00:00Z",
          "to": "2026-07-01T00:00:00Z"
        }
      }
    },
    "filters": [
      {
        "attribute": "agent",
        "values": [
          "a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04",
          "c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415"
        ],
        "operator": "IsOne"
      }
    ],
    "timezone": "Europe/Copenhagen",
    "pagination": {
      "pageLimit": 50
    },
    "includeLabels": true
  }'

Responses

One page of rows, each a map from column name to cell value, plus the adjacent-page pageKeys

Bodyapplication/json
dataArray of objects

The page's rows, one object per record row, in the record's own order. Which columns a row can carry is listed under fields in the record's catalogue entry

metaobject(PageResponse)required

The adjacent pages' pageKeys and the page size that was applied

Response
{
  "data": [
    { … },
    { … }
  ],
  "meta": {
    "next": "eyJ0aW1lc3RhbXAiOiIyMDI2LTA2LTE4VDEyOjMwOjAwLjBaIiwic2Vjb25kYXJ5S2V5IjoiNDQ3MSIsImxpbWl0Ijo1MCwiZGlyZWN0aW9uIjoibmV4dCJ9",
    "pageLimit": 50
  }
}