Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB

Get Characters Usage Metrics (Deprecated)

(Deprecated) This endpoint is deprecated. Use /v1/workspace/analytics/query/usage-by-product-over-time instead, which exposes the bucket size as interval_seconds (an integer in seconds) rather than aggregation_interval. 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.

get/v1/usage/character-stats

Query parameters

start_unixinteger required

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.

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_unixinteger required

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.

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_metricsboolean

Whether or not to include the statistics of the entire workspace.

Whether or not to include the statistics of the entire workspace.

breakdown_type'none' | 'voice' | 'voice_multiplier' | 'user' | 'groups' | 'api_keys' | 'all_api_keys' | 'product_type' | 'model' | 'resource' | 'request_queue' | 'region' | 'subresource_id' | 'reporting_workspace_id' | 'has_api_key' | 'request_source'

How to break down the information. Cannot be "user" or "api_key" if include_workspace_metrics is False.

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

aggregation_interval'hour' | 'day' | 'week' | 'month' | 'cumulative'

The time interval over which to aggregate the usage data.

How to aggregate usage data over time. Can be "hour", "day", "week", "month", or "cumulative".

aggregation_bucket_sizeinteger nullable

Aggregation bucket size in seconds. Overrides the aggregation interval.

Aggregation bucket size in seconds. Overrides the aggregation interval.

metric'credits' | 'tts_characters' | 'minutes_used' | 'request_count' | 'ttfb_avg' | 'ttfb_p95' | 'fiat_units_spent' | 'concurrency' | 'concurrency_average'

Which metric to aggregate.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

timeinteger[] required

The time axis with unix timestamps for each day.

usageobject required

The usage of each breakdown type along the time axis.

Example response

{
  "time": [
    1738252091000,
    1739404800000
  ],
  "usage": {
    "All": [
      49,
      1053
    ]
  }
}