Filter span groups

POST

https://api.respan.ai/api/request-logs/groups/

POST

/api/request-logs/groups/

$ curl -X POST https://api.respan.ai/api/request-logs/groups/ \
>      -H "Authorization: Bearer <respanApiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "count": 1,
3   "results": [
4     {
5       "date_group": "2024-01-15T09:30:00Z",
6       "model": "string",
7       "provider_id": "string",
8       "organization_key_id": "string",
9       "prompt_id": "string",
10       "deployment_id": "string",
11       "deployment_name": "string",
12       "custom_identifier": "string",
13       "customer_identifier": "string",
14       "trace_unique_id": "string",
15       "thread_identifier": "string",
16       "number_of_requests": 1,
17       "span_count": 1,
18       "total_cost": 1.1,
19       "total_tokens": 1,
20       "error_count": 1,
21       "error_percentage": 1.1,
22       "average_cost": 1.1,
23       "average_tokens": 1,
24       "average_latency": 1.1,
25       "average_ttft": 1.1,
26       "average_tps": 1.1,
27       "cache_hit_percentage": 1.1
28     }
29   ],
30   "next": "string",
31   "previous": "string",
32   "total_count": 1,
33   "current_filters": {},
34   "filters_data": {}
35 }

Group spans using the same query parameters as GET and optional standard Respan filters in the request body.

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.

AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Query parameters

group_byenumOptionalDefaults to model

Grouping dimension. trace and thread use entity rollups.

sort_bystringOptionalDefaults to number_of_requests

start_timedatetimeOptional

end_timedatetimeOptional

environmentstringOptional

pageintegerOptional>=1

page_sizeintegerOptional1-1000

Request

This endpoint expects an object.

filtersmap from strings to anyOptional

Response

Paginated groups and aggregate metrics.

countinteger

resultslist of objects

nextstring or nullOptional

previousstring or nullOptional

total_countintegerOptional

current_filtersmap from strings to anyOptional

filters_datamap from strings to anyOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error