Skip to main content
GET
/
api
/
v1
/
data
/
panel_annotations
cURL
curl --request GET \
  --url https://{tenant}.chronosphere.io/api/v1/data/panel_annotations \
  --header 'API-Token: <api-key>'
{
  "page": {
    "next_token": "<string>"
  },
  "panel_annotations": [
    {
      "created_by": "<string>",
      "id": "<string>",
      "labels": {},
      "starts_at": "2023-11-07T05:31:56Z",
      "target_reference": "<string>",
      "title": "<string>",
      "type": "DASHBOARD"
    }
  ]
}

Authorizations

​
API-Token
string
header
required

Chronosphere API token

Query Parameters

​
type
enum<string>

The type of the annotated resources to return.

Available options:
DASHBOARD
​
happened_after
string<date-time>

Returns only panel annotations after this timestamp with starts_at.

​
happened_before
string<date-time>

Returns only panel annotations before this with starts_at. If no value is provided, defaults to now.

​
target_references
string[]

Returns only annotations on resources with these slugs. If no value is provided, all resources of the provided type are returned.

​
labels[string]
string

Returns only panel annotations with all of these labels.

​
page.max_size
integer<int64>

Sets the preferred number of items to return per page. If set to 0, the server will use its default value. Regardless of the value specified, clients must never assume how many items will be returned.

​
page.token
string

An opaque page token that identifies which page the client should request. An empty value indicates the first page.

Response

A successful response.

​
page
object
​
panel_annotations
object[]