Skip to main content
GET
List annotation history

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.

Path Parameters

annotationID
string
required

Annotation ID (format ann-<number>).

Query Parameters

limit
integer

Maximum number of events to return (default 100).

Required range: 1 <= x <= 1000

Response

The annotation's events, newest first.

Maximum array length: 1000
id
string
required

Event ID (format anv-<number>).

annotationID
string
required

Annotation ID (format ann-<number>).

kind
enum<string>
required

What happened.

Available options:
created,
updated,
status-changed,
kind-changed,
deleted
actor
enum<string>
required

Who wrote the annotation or made a change.

Available options:
manual,
agent,
system
createdMs
integer<int64>
required

When it happened, in milliseconds since epoch.

message
string

The author's note.

data
object

Changed fields, each with its old and new value.