Sign in

v1

latestOpenAPI 3.0.32026-07-26191565482.4 KB
DataV1

put/api/v1/data/panel_annotations/{id}

Path parameters

idstring required

Unique identifier of the panel annotation.

Request body

labelsobject

Map of user-supplied key:value pairs associated with the event. The following maximums apply:

  • Number of labels per event: 50
  • Key character length: 200
  • Value character length: 500
starts_atstring date-time

The start time of the period being annotated.

titlestring

A short description explaining the annotation. Maximum character length: 100.

Response

A successful response.

created_bystring

Display name of the creator of this annotation.

idstring

Unique identifier of the panel annotation.

labelsobject

Map of user-supplied key:value pairs associated with the annotation. The following maximums apply:

  • Number of labels per annotation: 50
  • Key character length: 200
  • Value character length: 500
starts_atstring date-time

The start of the time period being annotated.

target_referencestring

The slug of the resource being annotated.

titlestring

A short description explaining the annotation. Max length, 100 characters.

type'DASHBOARD'