provider GET /v1/usage/character-stats
@utdk/elevenlabs /v1/usage/character-stats
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.
start_unix query 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.
integer
end_unix query 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.
integer
include_workspace_metrics query
Whether or not to include the statistics of the entire workspace.
boolean
breakdown_type query
How to break down the information. Cannot be "user" if include_workspace_metrics is False.
enum: none, voice, voice_multiplier, user…
aggregation_interval query
How to aggregate usage data over time. Can be "hour", "day", "week", "month", or "cumulative".
enum: hour, day, week, month…
aggregation_bucket_size query
Aggregation bucket size in seconds. Overrides the aggregation interval.
metric query
Which metric to aggregate.
enum: credits, tts_characters, minutes_used, request_count…
xi-api-key header
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.

Try it

Authentication
Configure credentials for ElevenLabs API Documentation
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

usageCharacters
GET/v1/usage/character-stats
(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.

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.

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.

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

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

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

Aggregation bucket size in seconds. Overrides the aggregation interval.

Which metric to aggregate.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import elevenlabs from '@utdk/elevenlabs';

await elevenlabs.usageCharacters({
  "include_workspace_metrics": false
})