usage

Get Usage By Agent

Changed on

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

Request

  • Base URL
    https://api.agentphone.ai
  • URL
    https://api.agentphone.ai/v1/usage/by-agent
  • Auth
    HTTP bearer

Query parameters

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

IANA timezone, e.g. America/New_York

Response

Successful Response

reportGeneratedAtstring required
periodstring required
periodStartstring required
periodEndstring required

Changes