For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/api/latest/annotations/get-annotations-for-a-page.md. A documentation index is available at /llms.txt.

Get annotations for a page

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/annotation/page/{page_id}https://api.ap2.datadoghq.com/api/v2/annotation/page/{page_id}https://api.datadoghq.eu/api/v2/annotation/page/{page_id}https://api.ddog-gov.com/api/v2/annotation/page/{page_id}https://api.us2.ddog-gov.com/api/v2/annotation/page/{page_id}https://api.uk1.datadoghq.com/api/v2/annotation/page/{page_id}https://api.datadoghq.com/api/v2/annotation/page/{page_id}https://api.us3.datadoghq.com/api/v2/annotation/page/{page_id}https://api.us5.datadoghq.com/api/v2/annotation/page/{page_id}

Overview

Returns 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.

Arguments

Path Parameters

Name

Type

Description

page_id [required]

string

The ID of the page, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890).

Query Strings

Name

Type

Description

start_time [required]

integer

Start of the time window in milliseconds since the Unix epoch.

end_time [required]

integer

End of the time window in milliseconds since the Unix epoch.

Response

OK

Response containing all annotations on a page, grouped by widget.

Expand All

Field

Type

Description

data [required]

object

Annotations grouped by widget for a single page.

attributes [required]

object

Attributes of the annotations on a page.

annotations [required]

object

Map of annotation UUID to annotation object, keyed by annotation ID.

<any-key>

object

A flat annotation object as it appears within a page annotations response.

author_id [required]

string

Identifier of the user who created the annotation.

color [required]

enum

Color used to render the annotation in the UI. Allowed enum values: gray,blue,purple,green,yellow,red

created_at [required]

int64

Creation time of the annotation in milliseconds since the Unix epoch.

description [required]

string

User-defined text attached to the annotation.

end_time [required]

int64

End time of the annotation in milliseconds since the Unix epoch. Null for pointInTime annotations.

id [required]

uuid

Unique identifier of the annotation.

modified_at [required]

int64

Last modification time of the annotation in milliseconds since the Unix epoch.

page_id [required]

string

ID of the page the annotation belongs to, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890).

start_time [required]

int64

Start time of the annotation in milliseconds since the Unix epoch.

type [required]

enum

Kind of annotation. pointInTime annotations mark a single moment in time, while timeRegion annotations span a window of time and require an end_time. Allowed enum values: pointInTime,timeRegion

widget_ids

[string]

IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page.

global_annotations [required]

[string]

List of annotation IDs that apply to the entire page rather than a specific widget.

widget_mapping [required]

object

Map from widget ID to the list of annotation IDs displayed on that widget.

<any-key>

[string]

List of annotation IDs displayed on a widget.

id [required]

string

ID of the page, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890).

type [required]

enum

Page annotations resource type. Allowed enum values: page_annotations

{
  "data": {
    "attributes": {
      "annotations": {
        "<any-key>": {
          "author_id": "00000000-0000-0000-0000-000000000000",
          "color": "blue",
          "created_at": 1704067200000,
          "description": "Deployed v2.3.1 to production.",
          "end_time": 1704070800000,
          "id": "00000000-0000-0000-0000-000000000000",
          "modified_at": 1704067200000,
          "page_id": "dashboard:abc-def-xyz",
          "start_time": 1704067200000,
          "type": "pointInTime",
          "widget_ids": [
            "1234567890"
          ]
        }
      },
      "global_annotations": [
        "00000000-0000-0000-0000-000000000001"
      ],
      "widget_mapping": {
        "<any-key>": [
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    },
    "id": "dashboard:abc-def-xyz",
    "type": "page_annotations"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Internal Server Error

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Code Example

                  # Path parameters
export page_id="dashboard:abc-def-xyz"
# Required query arguments
export start_time="1.7040672e+12"
export end_time="1.7041536e+12"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/annotation/page/${page_id}?start_time=${start_time}&end_time=${end_time}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}"
"""
Get annotations for a page returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.annotations_api import AnnotationsApi

# there is a valid "annotation" in the system
ANNOTATION_DATA_ATTRIBUTES_PAGE_ID = environ["ANNOTATION_DATA_ATTRIBUTES_PAGE_ID"]

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["get_page_annotations"] = True
with ApiClient(configuration) as api_client:
    api_instance = AnnotationsApi(api_client)
    response = api_instance.get_page_annotations(
        page_id=ANNOTATION_DATA_ATTRIBUTES_PAGE_ID,
        start_time=1704067200000,
        end_time=1704153600000,
    )

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"
# Get annotations for a page returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
  config.unstable_operations["v2.get_page_annotations".to_sym] = true
end
api_instance = DatadogAPIClient::V2::AnnotationsAPI.new

# there is a valid "annotation" in the system
ANNOTATION_DATA_ATTRIBUTES_PAGE_ID = ENV["ANNOTATION_DATA_ATTRIBUTES_PAGE_ID"]
p api_instance.get_page_annotations(ANNOTATION_DATA_ATTRIBUTES_PAGE_ID, 1704067200000, 1704153600000)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"
// Get annotations for a page returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	// there is a valid "annotation" in the system
	AnnotationDataAttributesPageID := os.Getenv("ANNOTATION_DATA_ATTRIBUTES_PAGE_ID")

	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.GetPageAnnotations", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewAnnotationsApi(apiClient)
	resp, r, err := api.GetPageAnnotations(ctx, AnnotationDataAttributesPageID, 1704067200000, 1704153600000)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AnnotationsApi.GetPageAnnotations`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `AnnotationsApi.GetPageAnnotations`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"
// Get annotations for a page returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.AnnotationsApi;
import com.datadog.api.client.v2.model.PageAnnotationsResponse;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    defaultClient.setUnstableOperationEnabled("v2.getPageAnnotations", true);
    AnnotationsApi apiInstance = new AnnotationsApi(defaultClient);

    // there is a valid "annotation" in the system
    String ANNOTATION_DATA_ATTRIBUTES_PAGE_ID = System.getenv("ANNOTATION_DATA_ATTRIBUTES_PAGE_ID");

    try {
      PageAnnotationsResponse result =
          apiInstance.getPageAnnotations(
              ANNOTATION_DATA_ATTRIBUTES_PAGE_ID, 1704067200000L, 1704153600000L);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnnotationsApi#getPageAnnotations");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"
// Get annotations for a page returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_annotations::AnnotationsAPI;

#[tokio::main]
async fn main() {
    // there is a valid "annotation" in the system
    let annotation_data_attributes_page_id =
        std::env::var("ANNOTATION_DATA_ATTRIBUTES_PAGE_ID").unwrap();
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.get_page_annotations", true);
    let api = AnnotationsAPI::with_config(configuration);
    let resp = api
        .get_page_annotations(
            annotation_data_attributes_page_id.clone(),
            1704067200000,
            1704153600000,
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
 * Get annotations for a page returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration({
  authMethods: {
    AuthZ: {
      accessToken: process.env.DD_BEARER_TOKEN as string,
    },
  },
});
configuration.unstableOperations["v2.getPageAnnotations"] = true;
const apiInstance = new v2.AnnotationsApi(configuration);

// there is a valid "annotation" in the system
const ANNOTATION_DATA_ATTRIBUTES_PAGE_ID = process.env
  .ANNOTATION_DATA_ATTRIBUTES_PAGE_ID as string;

const params: v2.AnnotationsApiGetPageAnnotationsRequest = {
  pageId: ANNOTATION_DATA_ATTRIBUTES_PAGE_ID,
  startTime: 1704067200000,
  endTime: 1704153600000,
};

apiInstance
  .getPageAnnotations(params)
  .then((data: v2.PageAnnotationsResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"