Annotations

Create annotation

Create a chart annotation.

post/api/v1/annotations

Request

Base URL
https://api.uptrace.dev
Auth
- API key in header uptrace-dsn
- or API key in query parameter dsn
TypeScript
https://skmtc.dev/uptrace/apis/uptrace-json-api/docs/api/v1/annotations/post.ts
A function with typed inputs. Its response is checked against the schema.

namestring required

Annotation name.

descriptionstring

Annotation description text in Markdown format.

colorstring

Color to be used in charts.

attrsobject

Key-value metadata.

fingerprintstring

Unique string used for deduplication.

timestring date-time

Overrides annotation time in RFC3339 format.

Annotation created.

No recorded changes to this operation across all 1 revision of this API.