Get Usage By Agent | AgentPhone

import { AgentPhoneClient } from "agentphone";
async function main() {
    const client = new AgentPhoneClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.usage.getUsageByAgent({
        period: "month",
        tz: "America/New_York",
    });
}
main();

{
  "data": [
    {
      "agentId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
      "agentName": "Support Agent 1",
      "messages": 245,
      "calls": 37,
      "totalSeconds": 4520,
      "isOrphan": false
    },
    {
      "agentId": "b2c3d4e5-f678-9012-ab34-cd56ef789012",
      "agentName": "Sales Agent 3",
      "messages": 180,
      "calls": 22,
      "totalSeconds": 3105,
      "isOrphan": false
    },
    {
      "agentId": null,
      "agentName": "Unassigned",
      "messages": 15,
      "calls": 3,
      "totalSeconds": 420,
      "isOrphan": true
    }
  ],
  "period": "month",
  "periodStart": "2024-06-01T00:00:00Z",
  "periodEnd": "2024-06-30T23:59:59Z"
}

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”.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

periodenumRequired

Allowed values:

tzstring or nullOptional

IANA timezone, e.g. America/New_York

Response

Successful Response

datalist of objects

periodstring

periodStartstring

periodEndstring

Errors

422

Unprocessable Entity Error