Skip to main content
GET
/
api
/
accounts
/
me
/
usage
/
calls
cURL
curl --request GET \
  --url https://api.ultravox.ai/api/accounts/me/usage/calls \
  --header 'X-API-Key: <api-key>'
{
  "allTime": {
    "totalCount": 123,
    "errorCount": 123,
    "duration": "<string>",
    "joinedCount": 123,
    "billedMinutes": 123
  },
  "daily": [
    {
      "totalCount": 123,
      "errorCount": 123,
      "duration": "<string>",
      "joinedCount": 123,
      "billedMinutes": 123,
      "date": "2023-12-25"
    }
  ],
  "hourly": [
    {
      "totalCount": 123,
      "errorCount": 123,
      "duration": "<string>",
      "joinedCount": 123,
      "billedMinutes": 123,
      "date": "2023-12-25",
      "hour": 123
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

API key

Query Parameters

​
agentIds
string<uuid>[]

Filter calls by the agent IDs.

​
durationMax
string

Maximum duration of calls

​
durationMin
string

Minimum duration of calls

​
fromDate
string<date-time>

Start datetime (inclusive) for filtering calls by creation date. If no time component is present, this defaults to the start of the day (midnight).

​
metadata
object

Filter calls by metadata. Use metadata.key=value to filter by specific key-value pairs.

​
search
string

The search string used to filter results

Minimum string length: 1
​
timeOfDayEnd
string<time>
default:23:59:59.999999

Filter calls by the time of day of their creation, regardless of date. Format: HH:MM:SS. Defaults to 23:59:59 if not specified.

​
timeOfDayStart
string<time>
default:00:00:00

Filter calls by the time of day of their creation, regardless of date. Format: HH:MM:SS. Defaults to 00:00:00 if not specified.

​
toDate
string<date-time>

End datetime (inclusive) for filtering calls by creation date. If no time component is present, this defaults to the end of the day (11:59:59.999999 PM).

​
voiceId
string<uuid>

Filter calls by the associated voice ID

Response

200 - application/json
​
allTime
object
required

All-time call usage

​
daily
object[]
required

Call usage per day

​
hourly
object[]
required

Call counts by date and hour