usage_characters
Retrieve character usage metrics for a specified time range, with options to break down by voice, user, or API key.
Instructions
Get Characters Usage Metrics (Deprecated) Deprecated upstream.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| metric | No | Which metric to aggregate. | |
| end_unix | Yes | 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. | |
| start_unix | Yes | 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. | |
| breakdown_type | No | How to break down the information. Cannot be "user" if include_workspace_metrics is False. | |
| aggregation_interval | No | How to aggregate usage data over time. Can be "hour", "day", "week", "month", or "cumulative". | |
| aggregation_bucket_size | No | Aggregation bucket size in seconds. Overrides the aggregation interval. | |
| include_workspace_metrics | No | Whether or not to include the statistics of the entire workspace. |