Skip to main content
GET
Get 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.

Path Parameters

annotationID
string
required

Annotation ID (format ann-<number>).

Response

The annotation.

id
string
required

Annotation ID (format ann-<number>).

kind
enum<string>
required

What the annotation records: event something changed, period something held over a span, setup a fact about how the project works, interpretation how to read the data, constraint which data may be used, follow-up an unknown or open work.

Available options:
event,
period,
setup,
interpretation,
constraint,
follow-up
platform
boolean
required

Platform annotation that applies to every project; managed by Corbado.

headline
string
required

One line saying what the annotation records.

approximate
boolean
required

The date is not exact.

display
boolean
required

Shown on charts.

source
enum<string>
required

Who wrote the annotation or made a change.

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

Creation time in milliseconds since epoch.

updatedMs
integer<int64>
required

Last update time in milliseconds since epoch.

description
string

Optional Markdown body with details.

dateFrom
string

Date as stated, in project time (UTC for platform annotations), in the format of its precision.

dateTo
string

Last unit a period covers (inclusive), in the same format. Absent on an ongoing period.

datePrecision
enum<string>

Unit the annotation's dates were stated in.

Available options:
month,
date,
hour,
datetime
dateFromMs
integer<int64>

Start of dateFrom in milliseconds since epoch.

dateToMs
integer<int64>

End of the span (exclusive) in milliseconds since epoch.

status
enum<string>

Where a follow-up stands.

Available options:
open,
done
effect
enum<string>

How an event or period changes the reading of the data: context background only, boundary compare only within one side, degraded data partly wrong, broken data wrong, missing no data.

Available options:
context,
boundary,
degraded,
broken,
missing
reading
string

Reading rule this date brings (events and periods).

scope
object

Narrows what the annotation applies to, by time-series dimension. Absent means the whole project.

series
string[]
Maximum array length: 50
evidence
enum<string>[]
Maximum array length: 4

Kind of evidence an annotation rests on.

Available options:
code,
trace,
data,
customer
refs
object[]
Maximum array length: 50
externalKey
string