GET
/
usage
Get usage data
curl --request GET \
  --url https://app.phonely.ai/api/usage \
  --header 'X-Authorization: <api-key>'
{
  "summary": {
    "totalCallCount": 123,
    "totalCallMinutes": 123,
    "agentCount": 123,
    "orgCount": 123
  },
  "agents": [
    {
      "agentId": "<string>",
      "agentName": "<string>",
      "orgId": "<string>",
      "orgName": "<string>",
      "callCount": 123,
      "callMinutes": 123
    }
  ],
  "dateRange": {
    "startDate": "2023-12-25",
    "endDate": "2023-12-25"
  },
  "requestedAgentId": "<string>"
}

Authorizations

X-Authorization
string
header
required

Query Parameters

uid
string
required

User ID

startDate
string
required

Start date in YYYY-MM-DD format

endDate
string
required

End date in YYYY-MM-DD format

agentId
string

Optional agent ID to filter data for specific agent

Response

200
application/json

Successful response

The response is of type object.