---
title: "Get Overview Analytics"
method: GET
path: "/v1/agent-analytics/overview"
---

# Get Overview Analytics

`GET /v1/agent-analytics/overview`

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

## Query parameters

- `voiceAgentId` string, uuid
- `period` 'LAST_HOUR' | 'TODAY' | 'YESTERDAY' | 'THIS_WEEK' | 'THIS_MONTH' | 'CUSTOM'
- `startPeriod` string
- `endPeriod` string
- `timeDifference` string

## Response `200`

Successful response

- GetOverviewAnalyticsResponse
  - `success` boolean
  - `data` object
    - `liveSessionsNumber` number — The number of currently active live sessions.
    - `totalSessionsNumber` number — The total number of sessions in the specified period.
    - `averageSessionDuration` number — The average duration of sessions in seconds.
    - `averageMessagesPerSession` number — The average number of messages exchanged per session.
    - `totalSessionDuration` number — The total duration of all sessions in seconds.
    - `averageWordsPerAiResponse` number — The average number of words in AI responses.
    - `forwardToHumanAgent` number — The number of sessions forwarded to a human agent.
    - `callsOverTime` object[] — Array of call counts grouped by time buckets.
      - `timeBucket` string — The time bucket timestamp.
      - `count` string — The number of calls in this time bucket.
    - `callsByDurationBuckets` object — Calls grouped by duration categories.
      - `shortDurationBucketCalls` number — Number of short duration calls.
      - `mediumDurationBucketCalls` number — Number of medium duration calls.
      - `longDurationBucketCalls` number — Number of long duration calls.

## Other responses

- `400` — Bad request - validation error
- `401` — Unauthorized
- `500` — Server Side Error

---

[API](https://skmtc.net/tryhamsa/apis/hamsa-api.md) · [All operations](https://skmtc.net/tryhamsa/apis/hamsa-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tryhamsa/hamsa-api/versions/ecbeb5d8dc13/schema)