Query Annotations

POST 
/preview/annotations/query

Query Annotations

Request

application/json

Body

anyOf
AnnotationQueryRequest
annotationobject
anyOf
AnnotationQuery
trace_idobject
anyOf
MOD1
string
span_idobject
anyOf
MOD1
string
kindobject
anyOf
AnnotationKind
string
Possible values: [custom, human, auto]
sourceobject
anyOf
AnnotationSource
string
Possible values: [web, sdk, api]
metadataobject
anyOf
referencesobject
anyOf
AnnotationReferences
evaluatorobjectrequired
idobject
anyOf
MOD1
string
slugobject
anyOf
MOD1
string
versionobject
anyOf
MOD1
string
attributesobject
property name* any
testsetobject
anyOf
AnnotationReference
idobject
anyOf
MOD1
string
slugobject
anyOf
MOD1
string
versionobject
anyOf
MOD1
string
attributesobject
property name* any
testcaseobject
anyOf
AnnotationReference
idobject
anyOf
MOD1
string
slugobject
anyOf
MOD1
string
versionobject
anyOf
MOD1
string
attributesobject
property name* any
linksobject
anyOf

Responses

200

Successful Response

application/json

Schema

Schema

count Count (integer)required
oldestobject

anyOf

MOD1

string

limitobject

anyOf

MOD1

integer

annotationsobject[]

Array [

created_atobject

anyOf

MOD1

string

updated_atobject

anyOf

MOD1

string

deleted_atobject

anyOf

MOD1

string

created_by_idobject

anyOf

MOD1

string

updated_by_idobject

anyOf

MOD1

string

deleted_by_idobject

anyOf

MOD1

string

span_id Span Id (string)required

trace_id Trace Id (string)required

kind AnnotationKind (string)

Possible values: [custom, human, auto]

Default value: custom

source AnnotationSource (string)

Possible values: [web, sdk, api]

Default value: api

dataobjectrequired

property name*FullJson-Output

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

MOD6

Array [

0

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

]

metadataobject

anyOf

referencesobjectrequired

evaluatorobjectrequired

idobject

anyOf

MOD1

string

slugobject

anyOf

MOD1

string

versionobject

anyOf

MOD1

string

testsetobject

anyOf

AnnotationReference

idobject

anyOf

MOD1

string

slugobject

anyOf

MOD1

string

versionobject

anyOf

MOD1

string

testcaseobject

anyOf

AnnotationReference

idobject

anyOf

MOD1

string

slugobject

anyOf

MOD1

string

versionobject

anyOf

MOD1

string

linksobjectrequired

property name*AnnotationLink

span_id Span Id (string)required

trace_id Trace Id (string)required

]

Example (from schema)

{
  "count": 0,
  "oldest": "2025-05-15T13:01:54.340Z",
  "limit": 0,
  "annotations": [
    {
      "created_at": "2025-05-15T13:01:54.340Z",
      "updated_at": "2025-05-15T13:01:54.340Z",
      "deleted_at": "2025-05-15T13:01:54.340Z",
      "created_by_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "updated_by_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "deleted_by_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "span_id": "string",
      "trace_id": "string",
      "kind": "custom",
      "source": "api",
      "data": {},
      "metadata": {},
      "references": {
        "evaluator": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "slug": "string",
          "version": "string"
        },
        "testset": {},
        "testcase": {}
      },
      "links": {}
    }
  ]
}

422

Validation Error

application/json

Schema

Schema

detailobject[]

Array [

locobject[]required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...