Documentation menu
Analytics

Read token usage analytics

GET /api/v1/projects/{projectId}/environments/{environmentId}/analytics/token-usage

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Read token usage analytics.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Read token usage analytics.

query

NameTypeRequiredDescription
fromstringrequiredSets the inclusive start of the Analytics time window. Applies to Read token usage analytics.
tostringrequiredSets the exclusive end of the Analytics time window. Applies to Read token usage analytics.
agentRunIdstringoptionalFilters recorded invocations to one run, including records retained after conversation deletion.
agentIdstringoptionalSelects the Project Agent by its stable identifier. Applies to Read token usage analytics.
releaseIdstringoptionalFilters results to the specified immutable Project Release. Applies to Read token usage analytics.
deploymentIdstringoptionalFilters results to the specified Project Deployment. Applies to Read token usage analytics.
activationIdstringoptionalFilters 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"optionalFilters recorded invocations to the exact provider.
requestedModelstringoptionalFilters recorded invocations to the exact requested model identifier.
groupBy"model" | "provider" | "none"optionalGroups by provider and requested/response model, by provider alone, or by no model dimension.
granularity"hour" | "day" | "none"optionalUses UTC hourly or daily buckets, or none for the entire requested interval.
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to Read token usage analytics.
offsetintegeroptionalNumber of ordered breakdown rows to skip; use nextOffset from the preceding response. Summary covers the full filtered interval.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — summary: object (required); rows: array<object> (required); nextOffset: integer | null (required); coverage: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)