ADMINISTRATIONUsage

Get character usage metrics

Returns the usage metrics for the current user or the entire workspace they are part of. The response provides a time axis based on the specified aggregation interval (default: day), with usage values for each interval along that axis. Usage is broken down by the selected breakdown type. For example, breakdown type “voice” will return the usage of each voice for each interval along the time axis.

Headers

xi-api-keystringRequired

Query parameters

start_unixintegerRequired

UTC Unix timestamp for the start of the usage window, in milliseconds. To include the first day of the window, the timestamp should be at 00:00:00 of that day.

end_unixintegerRequired

UTC Unix timestamp for the end of the usage window, in milliseconds. To include the last day of the window, the timestamp should be at 23:59:59 of that day.

include_workspace_metricsbooleanOptionalDefaults to false
Whether or not to include the statistics of the entire workspace.
breakdown_typeenumOptional

How to break down the information. Cannot be “user” if include_workspace_metrics is False.

aggregation_intervalenumOptional
How to aggregate usage data over time. Can be "hour", "day", "week", "month", or "cumulative".
Allowed values:
metricenumOptional
Which metric to aggregate.

Response

Successful Response
timelist of integers
The time axis with unix timestamps for each day.
usagemap from strings to lists of doubles
The usage of each breakdown type along the time axis.

Errors