Get Usage By Agent | AgentPhone

const url = 'https://api.agentphone.ai/v1/usage/by-agent?period=month&tz=America%2FNew_York';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "data": [
    {
      "agentId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
      "agentName": "Support Agent Alpha",
      "messages": 152,
      "calls": 47,
      "totalSeconds": 7320,
      "isOrphan": false
    },
    {
      "agentId": "b2c3d4e5-f678-9012-ab34-cd56ef789012",
      "agentName": "Sales Agent Beta",
      "messages": 98,
      "calls": 30,
      "totalSeconds": 5400,
      "isOrphan": false
    },
    {
      "agentId": null,
      "agentName": "Unassigned",
      "messages": 25,
      "calls": 5,
      "totalSeconds": 600,
      "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

1	const url = 'https://api.agentphone.ai/v1/usage/by-agent?period=month&tz=America%2FNew_York';
2	const options = {
3	method: 'GET',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"data": [
3	{
4	"agentId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5	"agentName": "Support Agent Alpha",
6	"messages": 152,
7	"calls": 47,
8	"totalSeconds": 7320,
9	"isOrphan": false
10	},
11	{
12	"agentId": "b2c3d4e5-f678-9012-ab34-cd56ef789012",
13	"agentName": "Sales Agent Beta",
14	"messages": 98,
15	"calls": 30,
16	"totalSeconds": 5400,
17	"isOrphan": false
18	},
19	{
20	"agentId": null,
21	"agentName": "Unassigned",
22	"messages": 25,
23	"calls": 5,
24	"totalSeconds": 600,
25	"isOrphan": true
26	}
27	],
28	"period": "month",
29	"periodStart": "2024-06-01T00:00:00Z",
30	"periodEnd": "2024-06-30T23:59:59Z"
31	}