v1

latestOpenAPI 3.0.1MIT2026-07-26104203277.0 KB

Get Overview Analytics

Retrieves overview analytics for voice agents including live sessions, total sessions, average session duration, and calls over time.

get/v1/agent-analytics/overview

Query parameters

voiceAgentIdstring uuid
Example:48f7656f-098b-4c43-b165-7cfd2cc8ac30

The unique identifier of the voice agent. If not sent, the statistics will be for all voice agents.

period'LAST_HOUR' | 'TODAY' | 'YESTERDAY' | 'THIS_WEEK' | 'THIS_MONTH' | 'CUSTOM'
Example:TODAY

The period filter option. Defaults to TODAY.

startPeriodstring
Example:1737590399000

The start period timestamp in milliseconds sent in string format. Must be sent with CUSTOM date filter.

endPeriodstring
Example:1737590399000

The end period timestamp in milliseconds sent in string format. Must be sent with CUSTOM date filter.

timeDifferencestring
Example:-3

The time difference between the timezone of the user's machine to the UTC/GMT timezone.

Response

Successful response

successboolean

Example response

{
  "success": true,
  "data": {
    "liveSessionsNumber": 15,
    "totalSessionsNumber": 50,
    "averageSessionDuration": 6,
    "averageMessagesPerSession": 6,
    "totalSessionDuration": 6,
    "averageWordsPerAiResponse": 6,
    "forwardToHumanAgent": 60,
    "callsOverTime": [
      {
        "timeBucket": "2025-09-15 20:00:00",
        "count": "6"
      }
    ],
    "callsByDurationBuckets": {
      "shortDurationBucketCalls": 6,
      "mediumDurationBucketCalls": 6,
      "longDurationBucketCalls": 6
    }
  }
}