NFnforgeio
annotations

Find Annotations.

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

get/annotations

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/annotations
  • Auth
    • HTTP basic
    • or API key in header Authorization

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.

alertIdinteger

Find annotations for a specified alert.

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
dashboardUIDstring
dataJson
emailstring
idinteger
loginstring
newStatestring
panelIdinteger
prevStatestring
tagsstring[]
textstring
timeinteger
timeEndinteger
updatedinteger
userIdinteger

Changes

No recorded changes to this operation across all 2 revisions of this API.