v1

latestOpenAPI 3.0.32026-07-14314472448.6 KB

annotations

Find Annotations.

Starting in Grafana v6.4 regions annotations are now returned in one entity that now includes the timeEnd property.

get/annotations

Query parameters

frominteger

Find annotations created after specific epoch datetime in milliseconds.

tointeger

Find annotations created before specific epoch datetime in milliseconds.

userIdinteger

Limit response to annotations created by specific user.

userUIDstring

Limit response to annotations created by a specific user, identified by UID.

alertIdinteger

Find annotations for a specified alert rule by its ID. deprecated: AlertID is deprecated and will be removed in future versions. Please use AlertUID instead.

alertUIDstring

Find annotations for a specified alert rule by its UID.

dashboardIdinteger

Find annotations that are scoped to a specific dashboard

dashboardUIDstring

Find annotations that are scoped to a specific dashboard

panelIdinteger

Find annotations that are scoped to a specific panel

limitinteger

Max limit for results returned.

tagsstring[]

Use this to filter organization annotations. Organization annotations are annotations from an annotation data source that are not connected specifically to a dashboard or panel. You can filter by multiple tags.

type'alert' | 'annotation'

Return alerts or user created annotations

matchAnyboolean

Match any or all tags

Response

(empty)

alertIdinteger

alertNamestring

avatarUrlstring

createdinteger

dashboardIdinteger

Deprecated: Use DashboardUID and OrgID instead

dashboardUIDstring

dataJson

emailstring

idinteger

loginstring

newStatestring

panelIdinteger

prevStatestring

tagsstring[]

textstring

timeinteger

timeEndinteger

updatedinteger

userIdinteger

userUIDstring