List Span Groups

GET

https://host.com/apis/intake/v2/workspaces/:workspace/spans/groups

GET

/apis/intake/v2/workspaces/:workspace/spans/groups

$ curl -G https://host.com/apis/intake/v2/workspaces/workspace/spans/groups \
>      -H "Content-Type: application/json" \
>      -d by=trace_id \
>      -d page=1 \
>      -d page_size=10 \
>      -d sort=-span_count \
>      -d "filter[project]=nemo-analytics" \
>      -d "filter[status]=success" \
>      -d "filter[kind]=LLM" \
>      --data-urlencode "filter[started_at][$gte]=2024-05-01T00:00:00Z" \
>      --data-urlencode "filter[started_at][$lte]=2024-05-31T23:59:59Z"

1 {
2   "data": [
3     {
4       "group": {
5         "trace_id": "4f8b3a2c-9d7e-4f1a-bb3e-2a1c9d5e7f6a"
6       },
7       "span_count": 125
8     },
9     {
10       "group": {
11         "trace_id": "7a9d2e1b-3c4f-4d2a-8e5b-1f7c3a9d8b2e"
12       },
13       "span_count": 87
14     }
15   ],
16   "grouped_by": [
17     "trace_id"
18   ],
19   "pagination": {
20     "page": 1,
21     "page_size": 10,
22     "current_page_size": 2,
23     "total_pages": 5,
24     "total_results": 45
25   },
26   "sort": "-span_count",
27   "filter": {
28     "project": "nemo-analytics",
29     "status": "success",
30     "kind": "LLM",
31     "started_at": {
32       "$gte": "2024-05-01T00:00:00Z",
33       "$lte": "2024-05-31T23:59:59Z"
34     }
35   }
36 }

Path parameters

workspacestringRequired

Query parameters

bystringRequired

Comma-separated span fields to group by, e.g. trace_id or session_id,trace_id.

pageintegerOptional>=1Defaults to 1

Page number.

page_sizeintegerOptional1-1000Defaults to 10

Page size.

sortenumOptionalDefaults to -span_count

Allowed values:

filterobjectOptional

Filter spans by the same fields as the span list endpoint, then group matching spans by the comma-separated fields in the by query parameter.

Response

Successful Response

datalist of objects

grouped_bylist of enums

Span fields used to group the matching spans.

paginationobject

Pagination information.

sortstring

The field on which the results are sorted.

filtermap from strings to any

Filtering information.

Errors

400

Bad Request Error

422

Unprocessable Entity Error