Get Summary Analytics

Retrieve high-level totals for calls, spend, and credits.

GET /api/analytics/summary

Get Summary Analytics

cURL

curl --request GET \
  --url https://api.example.com/api/analytics/summary

200

{
  "success": true,
  "data": {
    "period": {},
    "calls": {
      "total": 123,
      "completed": 123,
      "failed": 123,
      "avg_duration_seconds": 123
    },
    "spend": {
      "total_credits": 123,
      "total_usd": 123,
      "by_component": {}
    },
    "credits": {
      "added": 123,
      "used": 123
    }
  }
}

Fetches aggregated totals across your entire account for a given time period. You can optionally filter the results to a specific agent.

Query Parameters

start_date · string

Start date in YYYY-MM-DD format. Defaults to 30 days ago.

end_date · string

End date in YYYY-MM-DD format. Defaults to today.

start_datetime · string

Start exact time in ISO 8601 format (e.g. 2024-03-01T14:30:00Z). Overrides start_date and changes data granularity to minutes.

end_datetime · string

End exact time in ISO 8601 format. Overrides end_date.

agent_id · string

Filter the summary to only include data for a specific agent.

Response

success · boolean

Indicates whether the request was successful.

data · object

Show properties

period · object

The actual time period used for the query, containing start and end strings.

calls · object

Show properties

total · integer

Total number of calls initiated.

completed · integer

Number of calls that completed successfully.

failed · integer

Number of calls that failed or encountered errors.

avg_duration_seconds · number

Average duration of calls in seconds.

spend · object

Show properties

total_credits · number

Total platform credits consumed.

total_usd · number

Estimated equivalent cost in USD.

by_component · object

Breakdown of costs across pipeline components: llm_input, llm_output, tts, stt, telephony, and platform_fee.

credits · object

Show properties

added · number

Total credits added to the account during this period.

used · number

Total credits consumed during this period.