Read token usage analytics
GET /api/v1/projects/{projectId}/environments/{environmentId}/analytics/token-usage
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Read token usage analytics. |
environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Read token usage analytics. |
query
| Name | Type | Required | Description |
|---|---|---|---|
from | string | required | Sets the inclusive start of the Analytics time window. Applies to Read token usage analytics. |
to | string | required | Sets the exclusive end of the Analytics time window. Applies to Read token usage analytics. |
agentRunId | string | optional | Filters recorded invocations to one run, including records retained after conversation deletion. |
agentId | string | optional | Selects the Project Agent by its stable identifier. Applies to Read token usage analytics. |
releaseId | string | optional | Filters results to the specified immutable Project Release. Applies to Read token usage analytics. |
deploymentId | string | optional | Filters results to the specified Project Deployment. Applies to Read token usage analytics. |
activationId | string | optional | Filters results to the specified Project Environment activation. Applies to Read token usage analytics. |
provider | "anthropic" | "google" | "openai" | "azure-openai" | "amazon-bedrock" | "google-vertex" | "deepseek" | "fireworks" | optional | Filters recorded invocations to the exact provider. |
requestedModel | string | optional | Filters recorded invocations to the exact requested model identifier. |
groupBy | "model" | "provider" | "none" | optional | Groups by provider and requested/response model, by provider alone, or by no model dimension. |
granularity | "hour" | "day" | "none" | optional | Uses UTC hourly or daily buckets, or none for the entire requested interval. |
limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to Read token usage analytics. |
offset | integer | optional | Number of ordered breakdown rows to skip; use nextOffset from the preceding response. Summary covers the full filtered interval. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — summary: object (required); rows: array<object> (required); nextOffset: integer | null (required); coverage: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |