Esta página aún no está disponible en español. Estamos trabajando en su traducción. Si tienes alguna pregunta o comentario sobre nuestro actual proyecto de traducción, no dudes en ponerte en contacto con nosotros.
Annotations
Add annotations to dashboards and notebooks to mark events such as deployments, incidents, or other notable moments in time.
Attributes of an annotation returned in a response.
author_id [required]
string
Identifier of the user who created the annotation.
color [required]
enum
Color used to render the annotation in the UI.
Allowed enum values: gray,blue,purple,green,yellow,red
created_at [required]
int64
Creation time of the annotation in milliseconds since the Unix epoch.
description [required]
string
User-defined text attached to the annotation.
end_time [required]
int64
End time of the annotation in milliseconds since the Unix epoch. Null for pointInTime annotations.
modified_at [required]
int64
Last modification time of the annotation in milliseconds since the Unix epoch.
page_id [required]
string
ID of the page the annotation belongs to, prefixed with the page type and joined by a colon
(for example, dashboard:abc-def-xyz or notebook:1234567890).
start_time [required]
int64
Start time of the annotation in milliseconds since the Unix epoch.
type [required]
enum
Kind of annotation. pointInTime annotations mark a single moment in time,
while timeRegion annotations span a window of time and require an end_time.
Allowed enum values: pointInTime,timeRegion
widget_ids
[string]
IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page.
{"data":[{"attributes":{"author_id":"00000000-0000-0000-0000-000000000000","color":"blue","created_at":1704067200000,"description":"Deployed v2.3.1 to production.","end_time":1704070800000,"modified_at":1704067200000,"page_id":"dashboard:abc-def-xyz","start_time":1704067200000,"type":"pointInTime","widget_ids":["1234567890"]},"id":"00000000-0000-0000-0000-000000000000","type":"annotation"}]}
Creates a new annotation on a dashboard or notebook page.
Valid color values: gray, blue, purple, green, yellow, red.
Valid type values: pointInTime (marks a single moment) or timeRegion (spans a range and requires end_time).
Attributes for creating or updating an annotation.
color [required]
enum
Color used to render the annotation in the UI.
Allowed enum values: gray,blue,purple,green,yellow,red
description [required]
string
User-defined text attached to the annotation.
end_time
int64
End time of the annotation in milliseconds since the Unix epoch. Required for timeRegion annotations; omit or set to null for pointInTime annotations.
page_id [required]
string
ID of the page the annotation belongs to, prefixed with the page type and joined by a colon
(for example, dashboard:abc-def-xyz or notebook:1234567890).
start_time [required]
int64
Start time of the annotation in milliseconds since the Unix epoch.
type [required]
enum
Kind of annotation. pointInTime annotations mark a single moment in time,
while timeRegion annotations span a window of time and require an end_time.
Allowed enum values: pointInTime,timeRegion
widget_ids
[string]
IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page.
{"data":{"attributes":{"color":"blue","description":"Deployed v2.3.1 to production.","page_id":"dashboard:abc-def-xyz","start_time":1704067200000,"type":"pointInTime","widget_ids":["1234567890"]},"type":"annotation"}}
Attributes of an annotation returned in a response.
author_id [required]
string
Identifier of the user who created the annotation.
color [required]
enum
Color used to render the annotation in the UI.
Allowed enum values: gray,blue,purple,green,yellow,red
created_at [required]
int64
Creation time of the annotation in milliseconds since the Unix epoch.
description [required]
string
User-defined text attached to the annotation.
end_time [required]
int64
End time of the annotation in milliseconds since the Unix epoch. Null for pointInTime annotations.
modified_at [required]
int64
Last modification time of the annotation in milliseconds since the Unix epoch.
page_id [required]
string
ID of the page the annotation belongs to, prefixed with the page type and joined by a colon
(for example, dashboard:abc-def-xyz or notebook:1234567890).
start_time [required]
int64
Start time of the annotation in milliseconds since the Unix epoch.
type [required]
enum
Kind of annotation. pointInTime annotations mark a single moment in time,
while timeRegion annotations span a window of time and require an end_time.
Allowed enum values: pointInTime,timeRegion
widget_ids
[string]
IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page.
{"data":{"attributes":{"author_id":"00000000-0000-0000-0000-000000000000","color":"blue","created_at":1704067200000,"description":"Deployed v2.3.1 to production.","end_time":1704070800000,"modified_at":1704067200000,"page_id":"dashboard:abc-def-xyz","start_time":1704067200000,"type":"pointInTime","widget_ids":["1234567890"]},"id":"00000000-0000-0000-0000-000000000000","type":"annotation"}}
Returns all annotations on a specific page for a given time window, grouped by widget.
Unlike ListAnnotations, this endpoint returns a single structured object with annotations
indexed by their ID and a widget-to-annotation mapping for easy UI rendering.
Argumentos
Parámetros de ruta
Nombre
Tipo
Descripción
page_id [required]
string
The ID of the page, prefixed with the page type and joined by a colon
(for example, dashboard:abc-def-xyz or notebook:1234567890).
Cadenas de consulta
Nombre
Tipo
Descripción
start_time [required]
integer
Start of the time window in milliseconds since the Unix epoch.
end_time [required]
integer
End of the time window in milliseconds since the Unix epoch.
Response containing all annotations on a page, grouped by widget.
Expand All
Campo
Tipo
Descripción
data [required]
object
Annotations grouped by widget for a single page.
attributes [required]
object
Attributes of the annotations on a page.
annotations [required]
object
Map of annotation UUID to annotation object, keyed by annotation ID.
<any-key>
object
A flat annotation object as it appears within a page annotations response.
author_id [required]
string
Identifier of the user who created the annotation.
color [required]
enum
Color used to render the annotation in the UI.
Allowed enum values: gray,blue,purple,green,yellow,red
created_at [required]
int64
Creation time of the annotation in milliseconds since the Unix epoch.
description [required]
string
User-defined text attached to the annotation.
end_time [required]
int64
End time of the annotation in milliseconds since the Unix epoch. Null for pointInTime annotations.
id [required]
uuid
Unique identifier of the annotation.
modified_at [required]
int64
Last modification time of the annotation in milliseconds since the Unix epoch.
page_id [required]
string
ID of the page the annotation belongs to, prefixed with the page type and joined by a colon
(for example, dashboard:abc-def-xyz or notebook:1234567890).
start_time [required]
int64
Start time of the annotation in milliseconds since the Unix epoch.
type [required]
enum
Kind of annotation. pointInTime annotations mark a single moment in time,
while timeRegion annotations span a window of time and require an end_time.
Allowed enum values: pointInTime,timeRegion
widget_ids
[string]
IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page.
global_annotations [required]
[string]
List of annotation IDs that apply to the entire page rather than a specific widget.
widget_mapping [required]
object
Map from widget ID to the list of annotation IDs displayed on that widget.
<any-key>
[string]
List of annotation IDs displayed on a widget.
id [required]
string
ID of the page, prefixed with the page type and joined by a colon
(for example, dashboard:abc-def-xyz or notebook:1234567890).
{"data":{"attributes":{"annotations":{"<any-key>":{"author_id":"00000000-0000-0000-0000-000000000000","color":"blue","created_at":1704067200000,"description":"Deployed v2.3.1 to production.","end_time":1704070800000,"id":"00000000-0000-0000-0000-000000000000","modified_at":1704067200000,"page_id":"dashboard:abc-def-xyz","start_time":1704067200000,"type":"pointInTime","widget_ids":["1234567890"]}},"global_annotations":["00000000-0000-0000-0000-000000000001"],"widget_mapping":{"<any-key>":["00000000-0000-0000-0000-000000000000"]}},"id":"dashboard:abc-def-xyz","type":"page_annotations"}}
Updates an existing annotation.
Valid color values: gray, blue, purple, green, yellow, red.
Valid type values: pointInTime (marks a single moment) or timeRegion (spans a range and requires end_time).
Attributes for creating or updating an annotation.
color [required]
enum
Color used to render the annotation in the UI.
Allowed enum values: gray,blue,purple,green,yellow,red
description [required]
string
User-defined text attached to the annotation.
end_time
int64
End time of the annotation in milliseconds since the Unix epoch. Required for timeRegion annotations; omit or set to null for pointInTime annotations.
page_id [required]
string
ID of the page the annotation belongs to, prefixed with the page type and joined by a colon
(for example, dashboard:abc-def-xyz or notebook:1234567890).
start_time [required]
int64
Start time of the annotation in milliseconds since the Unix epoch.
type [required]
enum
Kind of annotation. pointInTime annotations mark a single moment in time,
while timeRegion annotations span a window of time and require an end_time.
Allowed enum values: pointInTime,timeRegion
widget_ids
[string]
IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page.
Attributes of an annotation returned in a response.
author_id [required]
string
Identifier of the user who created the annotation.
color [required]
enum
Color used to render the annotation in the UI.
Allowed enum values: gray,blue,purple,green,yellow,red
created_at [required]
int64
Creation time of the annotation in milliseconds since the Unix epoch.
description [required]
string
User-defined text attached to the annotation.
end_time [required]
int64
End time of the annotation in milliseconds since the Unix epoch. Null for pointInTime annotations.
modified_at [required]
int64
Last modification time of the annotation in milliseconds since the Unix epoch.
page_id [required]
string
ID of the page the annotation belongs to, prefixed with the page type and joined by a colon
(for example, dashboard:abc-def-xyz or notebook:1234567890).
start_time [required]
int64
Start time of the annotation in milliseconds since the Unix epoch.
type [required]
enum
Kind of annotation. pointInTime annotations mark a single moment in time,
while timeRegion annotations span a window of time and require an end_time.
Allowed enum values: pointInTime,timeRegion
widget_ids
[string]
IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page.
{"data":{"attributes":{"author_id":"00000000-0000-0000-0000-000000000000","color":"blue","created_at":1704067200000,"description":"Deployed v2.3.1 to production.","end_time":1704070800000,"modified_at":1704067200000,"page_id":"dashboard:abc-def-xyz","start_time":1704067200000,"type":"pointInTime","widget_ids":["1234567890"]},"id":"00000000-0000-0000-0000-000000000000","type":"annotation"}}
