Optional requestFactory: AnnotationsApiRequestFactoryOptional responseProcessor: AnnotationsApiResponseProcessorPrivate configurationPrivate requestPrivate responseThe request object
Optional options: ConfigurationDeletes an existing annotation by ID.
Returns 204 No Content if the annotation does not exist (idempotent).
The request object
Optional options: ConfigurationReturns 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.
The request object
Optional options: ConfigurationReturns a flat list of annotations matching the given page, time window, and optional widget filter.
The request object
Optional options: ConfigurationUpdates 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).
The request object
Optional options: ConfigurationGenerated using TypeDoc
Creates a new annotation on a dashboard or notebook page. Valid
colorvalues:gray,blue,purple,green,yellow,red. Validtypevalues:pointInTime(marks a single moment) ortimeRegion(spans a range and requiresend_time).