Skip to main content
POST
Create annotation

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Body

application/json
headline
string
required

Short headline describing the annotation.

dateMs
integer<int64>
required

The annotated point in time in milliseconds since epoch.

description
string

Optional longer description of the annotation.

Response

Annotation created.

id
string
required

Annotation ID (format ann-<number>).

headline
string
required

Short headline describing the annotation.

dateMs
integer<int64>
required

The annotated point in time in milliseconds since epoch.

createdMs
integer<int64>
required

Creation time in milliseconds since epoch.

updatedMs
integer<int64>
required

Last update time in milliseconds since epoch.

description
string

Optional longer description of the annotation.