Skip to navigation

Get errors by dimension

Splits failed spans by a field, such as model or customer. The signals panel narrows by a group’s error_class, provider and status for its “Errors by model” and “Errors by customer” splits; groups that differ only by endpoint count together.

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, 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

This endpoint expects an object.
group_byenumRequired

Field to group by. issue groups by error group fingerprint, provider by provider ID, and status by HTTP status code.

start_timedatetimeOptional
Start of the range, ISO 8601. A time without an offset is read as UTC. Defaults to 7 days ago, which is also used if the value can't be parsed.
end_timedatetimeOptional
End of the range, ISO 8601. A time without an offset is read as UTC. Defaults to now, which is also used if the value can't be parsed.
environmentstringOptional

Only count spans from this environment, such as prod or test. Omit it to include every environment.

limitintegerOptional1-100Defaults to 100
Maximum groups to return. Values above 100 are capped at 100.
error_classenumOptional

Only this error class. For several values or is not, use filters.

fault_domainenumOptional

Only errors with this fault. none selects client cancellations.

Allowed values:
providerstringOptional
Only errors from this provider ID.
statusintegerOptional
Only errors with this HTTP status code.
filtersobjectOptional

Narrow the errors with the same filter shape as the Logs filter bar. Only these four keys are accepted; any other key is a 400.

Response

Failed spans per group.
group_byenum
groupslist of objects

Groups ordered by count, highest first.

Errors

400
Bad Request Error
403
Forbidden Error
429
Too Many Requests Error