v3

latestOpenAPI 3.1.02026-08-087684214.2 KB
usage

Get Usage By Agent

Get usage broken down by agent for the current calendar week, month, or year. Includes message count, completed call count, and total call seconds per agent. Calls/messages with no agent attached are bucketed as "Unassigned".

get/v1/usage/by-agent

Query parameters

period'week' | 'month' | 'year' required
tzstring nullable

IANA timezone, e.g. America/New_York

IANA timezone, e.g. America/New_York

Response

Successful Response

periodstring required
periodStartstring required
periodEndstring required