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": "<string>"
}
}
}
'{
"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
}Query various metrics about a agent, such as the number of conversations, the number of users, and the number of messages
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": "<string>"
}
}
}
'{
"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
}All requests to the ChatDash API must be validated with the agency API Key found on your agency profile
The ID of the agent
Show child attributes
The metrics to query
conversations, conversationByCountry, uniqueIps, totalCallDuration, totalCost, averageCost, topMisunderstoodMessages, topTopics, endedReason, interactions, incomingTextMessages, tokens, topIntents, understoodMessages, averageInteractions Show child attributes
OK
The average number of interactions per conversation