List records
GET
List the records you can query, with the fields and filters of each record and the metrics based on it. Use the record id with Query conversation records, Query agent records or Query AI agent records.
ApiKeyAuthheader
Authorization<token>category?stringOnly list records in this category. If not provided, all records are listed.
Value in
"conversations""agents""aiagents"pageKey?stringThe key of the page to fetch. To page through the results, call the link in meta.next or meta.previous of the previous response, which already carries this key.
pageLimit?integerThe number of entries per page, up to 1000. Defaults to 50, or to the page size of pageKey when one is given.
Format
int32Default
50The list of records
application/json- response
data?array<>meta?curl -X GET 'https://dev.dixa.io/beta/intelligence/records' \ -H 'Authorization: <API token>'{}
"data": []
{},
"id": "closedConversations",
"name": "Closed conversations",
"category": "conversations",
"description": "The conversations closed in the selected period, one row each",
"deprecated": false,
"primaryFilters": [],
"period",
"conversationIds"
"filters": [],
{},
"attribute": "agent",
"aliases": [],
"agentId"
"type": "Uuid",
"operators": [],
"IsEmpty",
"IsNotEmpty",
"IsOne",
"IsNotOne"
"defaultOperator": "IsOne",
"description": "The agent (AI or human) assigned to the conversation"
{},
"attribute": "queue",
"aliases": [],
"queueId"
"type": "Uuid",
"operators": [],
"IsEmpty",
"IsNotEmpty",
"IsOne",
"IsNotOne"
"defaultOperator": "IsOne",
"description": "The queue the conversation was routed to"
{},
"attribute": "team",
"aliases": [],
"teamId"
"type": "Uuid",
"operators": [],
"IsEmpty",
"IsNotEmpty",
"IsOne",
"IsNotOne"
"defaultOperator": "IsOne",
"description": "The team the conversation was assigned to"
{},
"attribute": "tag",
"aliases": [],
"tagId"
"type": "Uuid",
"operators": [],
"IsEmpty",
"IsNotEmpty",
"IsOne",
"IsNotOne",
"IsAll"
"defaultOperator": "IsOne",
"description": "A tag attached to the conversation"
{},
"attribute": "channel",
"aliases": [],
"type": "String",
"operators": [],
"IsOne",
"IsNotOne"
"defaultOperator": "IsOne",
"description": "The channel the conversation came in on"
{},
"attribute": "initialDirection",
"aliases": [],
"direction"
"type": "String",
"operators": [],
"IsOne",
"IsNotOne"
"defaultOperator": "IsOne",
"description": "The initial direction of the conversation"
{}
"attribute": "contactPoint",
"aliases": [],
"type": "String",
"operators": [],
"IsEmpty",
"IsNotEmpty",
"IsOne",
"IsNotOne"
"defaultOperator": "IsOne",
"description": "The contact point the conversation arrived through"
"fields": [],
{},
"name": "conversationId",
"type": "Integer",
"nullable": false,
"description": "The conversation id"
{},
"name": "closedAt",
"type": "Timestamp",
"nullable": false,
"description": "When the conversation was closed"
{},
"name": "agent",
"type": "Entity",
"nullable": true,
"description": "The agent who closed the conversation",
"idType": "Uuid"
{},
"name": "queue",
"type": "Entity",
"nullable": true,
"description": "The queue the conversation was in when it was closed",
"idType": "Uuid"
{},
"name": "closedBy",
"type": "Entity",
"nullable": false,
"description": "Who closed the conversation — an agent, the end user, or unknown",
"idType": "String"
{},
"name": "channel",
"type": "Entity",
"nullable": true,
"description": "The channel the conversation came in on",
"idType": "String"
{},
"name": "initialDirection",
"type": "Entity",
"nullable": true,
"description": "The initial direction of the conversation",
"idType": "String"
{},
"name": "contactPoint",
"type": "Entity",
"nullable": true,
"description": "The contact point the conversation arrived through",
"idType": "String"
{}
"name": "tags",
"type": "List",
"nullable": true,
"description": "The tags attached to the conversation",
"items": {}
"type": "Entity",
"idType": "Uuid"
"relatedMetricIds": []
"closedConversations"
{}
"id": "agentPresenceDuration",
"name": "Agent presence duration",
"category": "agents",
"description": "An agent's completed presence intervals in the selected period, one row each",
"deprecated": false,
"primaryFilters": [],
"period"
"filters": [],
{}
"attribute": "agent",
"aliases": [],
"agentId"
"type": "Uuid",
"operators": [],
"IsEmpty",
"IsNotEmpty",
"IsOne",
"IsNotOne"
"defaultOperator": "IsOne",
"description": "The agent (AI or human) assigned to the conversation"
"fields": [],
{},
"name": "endedAt",
"type": "Timestamp",
"nullable": false,
"description": "When the interval ended"
{},
"name": "agent",
"type": "Entity",
"nullable": false,
"description": "The agent the interval belongs to",
"idType": "Uuid"
{},
"name": "startedAt",
"type": "Timestamp",
"nullable": false,
"description": "When the interval started"
{},
"name": "working",
"type": "Boolean",
"nullable": false,
"description": "Whether the agent was working (vs away) during the interval"
{},
"name": "availableOnEmail",
"type": "Boolean",
"nullable": false,
"description": "Whether the agent was available on email"
{},
"name": "availableOnChat",
"type": "Boolean",
"nullable": false,
"description": "Whether the agent was available on interactive chat"
{},
"name": "availableOnMessage",
"type": "Boolean",
"nullable": false,
"description": "Whether the agent was available on messaging"
{},
"name": "availableOnSpeak",
"type": "Boolean",
"nullable": false,
"description": "Whether the agent was available on voice"
{},
"name": "simultaneousRing",
"type": "Boolean",
"nullable": false,
"description": "Whether simultaneous ring was enabled"
{}
"name": "customAwayStatus",
"type": "Entity",
"nullable": true,
"description": "The custom away status, when the agent was away on one",
"idType": "Uuid"
"relatedMetricIds": []
"agentPresenceDuration"
Shortened to two records. The real response lists all records