Get record

GET
/beta/intelligence/records/{recordId}

Get a record by id.

Authorization

ApiKeyAuth
headerAuthorization<token>

Path Parameters

recordId*string

The record id

Response Body

The record

application/json
  1. response
data*

A record and how to query it

Example Request
curl -X GET 'https://dev.dixa.io/beta/intelligence/records/{recordId}' \  -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"
]
}
}

A record you can query by period or conversation ids, with seven filters and a list of tags