Skip to main content
POST
/
agents
/
{agentId}
/
analytics
/
query
Query Agent Analytics
curl --request POST \
  --url https://api.chat-dash.com/v1/public/agents/{agentId}/analytics/query \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": {
    "metrics": [
      "conversations"
    ],
    "filter": {
      "startTime": "<string>",
      "endTime": "<string>",
      "utcOffset": 123
    }
  }
}'
{
  "conversations": {
    "counts": [
      123
    ],
    "total": 123
  },
  "conversationsByCountry": [
    {
      "id": "<string>",
      "value": 123
    }
  ],
  "uniqueIps": {
    "counts": [
      123
    ],
    "total": 123
  },
  "totalCallDuration": {
    "counts": [
      123
    ],
    "total": 123
  },
  "totalCost": {
    "counts": [
      123
    ],
    "total": 123,
    "currency": "<string>"
  },
  "averageCost": {
    "counts": [
      123
    ],
    "average": 123,
    "currency": "<string>"
  },
  "endedReason": [
    {
      "reason": "<string>",
      "count": 123
    }
  ],
  "topMisunderstoodMessages": [
    {
      "id": "<string>",
      "label": "<string>",
      "count": 123
    }
  ],
  "topTopics": [
    {
      "id": "<string>",
      "label": "<string>",
      "count": 123
    }
  ],
  "interactions": {
    "counts": [
      123
    ],
    "total": 123
  },
  "incomingTextMessages": {
    "counts": [
      123
    ],
    "total": 123
  },
  "tokens": [
    {
      "model": "<string>",
      "count": 123
    }
  ],
  "topIntents": [
    {
      "name": "<string>",
      "count": 123
    }
  ],
  "understoodMessages": {
    "total": 123,
    "understood": 123,
    "missed": 123
  },
  "averageInteractions": 123
}

Headers

Authorization
string
required

All requests to the ChatDash API must be validated with the agency API Key found on your agency profile

Path Parameters

agentId
string
required

The ID of the agent

Body

application/json
query
object
required

Response

OK

conversations
object
conversationsByCountry
object[]
uniqueIps
object
totalCallDuration
object
totalCost
object
averageCost
object
endedReason
object[]
topMisunderstoodMessages
object[]
Maximum length: 5
topTopics
object[]
Maximum length: 5
interactions
object
incomingTextMessages
object
tokens
object[]
topIntents
object[]
understoodMessages
object
averageInteractions
integer

The average number of interactions per conversation

I