API reference
Usage
What your organization consumed: credits (1 credit = 1 worked contact), calls and time on the line, over any period and per assistant and campaign, with the balance and the date it runs out at the recent pace.
Endpoints
The Usage object
Usage
{
"period": {
"from": "from",
"to": "to",
"granularity": "hour",
"timezone": "Europe/Paris"
},
"previous_period": { "from": "from", "to": "to" },
"totals": {
"credits_used": 1,
"amount_cents": 1,
"calls": 1,
"connected_calls": 1,
"talk_seconds": 98,
"credits_by_kind": {
"reached": 1,
"not_reached": 1,
"inbound": 1,
"per_minute": 1
},
"credits_added": 1
},
"previous_totals": {
"credits_used": 1,
"amount_cents": 1,
"calls": 1,
"connected_calls": 1,
"talk_seconds": 98,
"credits_by_kind": {
"reached": 1,
"not_reached": 1,
"inbound": 1,
"per_minute": 1
},
"credits_added": 1
},
"series": [
{
"credits_used": 1,
"amount_cents": 1,
"calls": 1,
"connected_calls": 1,
"talk_seconds": 98,
"credits_by_kind": {
"reached": 1,
"not_reached": 1,
"inbound": 1,
"per_minute": 1
},
"start": "start"
}
],
"by_assistant": [
{
"assistant_id": "3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e34",
"name": "Appointment reminder",
"credits_used": 1,
"amount_cents": 1,
"calls": 1,
"connected_calls": 1,
"talk_seconds": 98
}
],
"by_campaign": [
{
"campaign_id": "9b2d7e41-6c3f-4a8e-b5d0-2f7a1c9e4b63",
"name": "Appointment reminder",
"credits_used": 1,
"amount_cents": 1,
"calls": 1,
"connected_calls": 1,
"talk_seconds": 98
}
],
"balance": {
"credits": 1,
"plan": "starter",
"plan_monthly_credits": 1,
"next_expiry": {
"credits": 1,
"expires_at": "2026-11-05T09:00:00Z"
},
"daily_average_credits": 1,
"depletion_date": "2026-11-02"
}
}