Sign in

4e064cf81dae

latestOpenAPI 3.1.02026-08-131831,331960.0 KB
dashboard

List metrics broken down by dimension

Return time-series metrics broken down by a dimension. Span scope supports full filtering and dimensions; trace scope accepts no body filters and only customer or organization-key breakdowns; thread scope accepts neither filters nor a breakdown dimension. Each requested metric is a top-level key whose value is an array of time buckets.

post/api/dashboard/time-series/breakdown/

Query parameters

summary_type'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' | 'last_24h' | 'all'

Preset time range. Use this or explicit start_time / end_time.

datestring date

Base date used with summary_type presets.

start_timestring date-time

Optional explicit ISO start time.

end_timestring date-time

Optional explicit ISO end time.

time_tick'minute' | 'hour' | 'day'

Bucket granularity for time-series responses.

timezone_offsetnumber double

Timezone offset, in hours, used when resolving preset ranges.

breakdown_by'model' | 'organization_key_id' | 'customer_identifier' | 'custom_identifier' | 'prompt_id' | 'deployment_id' | 'deployment_name' | 'provider_id'

Dimension to break the time series down by.

scope'span' | 'trace' | 'thread'

Aggregation unit.

Headers

Authorizationstring required

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Request body

metrics_to_aggregateApiDashboardTimeSeriesBreakdownPostRequestBodyContentApplicationJsonSchemaMetricsToAggregateItems[]

Metrics to return. Supported values depend on scope; when omitted the API returns number of requests, total cost, and total tokens.

Response

Metric-keyed time-series breakdown.

object required