API ReferenceDashboard

List metrics broken down by dimension

Returns a time series broken down by a chosen dimension (model, organization key, customer, prompt, deployment, or provider). Each row is one bucket with one column per dimension value. Top values are kept; the rest are folded into Others.

Authentication

AuthorizationBearer

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, OpenAI or Azure OpenAI provider credentials go in Settings -> Providers or the request body credential_override field, not in this auth field.

Query parameters

summary_typeenumOptionalDefaults to all

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

datedateOptional

Base date used with summary_type presets.

start_timedatetimeOptional
Optional explicit ISO start time.
end_timedatetimeOptional
Optional explicit ISO end time.
time_tickenumOptionalDefaults to hour

Bucket granularity for time-series responses.

Allowed values:
timezone_offsetdoubleOptionalDefaults to 0
Timezone offset, in hours, used when resolving preset ranges.
breakdown_byenumOptionalDefaults to model
Dimension to break the time series down by.

Request

This endpoint expects an object.
filtersobjectOptional

Filter criteria. See Filters API Reference for operator syntax.

Response

Successful response.
date_groupdatetime