For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/annotations/list-annotations.md. A documentation index is available at /llms.txt.
homeHomedocsDocsapiAPI
Language
Datadog site

List annotations

WARNINGNote: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.
GEThttps://api.datadoghq.com/api/v2/annotationhttps://api.us3.datadoghq.com/api/v2/annotationhttps://api.us5.datadoghq.com/api/v2/annotationhttps://api.datadoghq.eu/api/v2/annotationhttps://api.ap1.datadoghq.com/api/v2/annotationhttps://api.ap2.datadoghq.com/api/v2/annotationhttps://api.uk1.datadoghq.com/api/v2/annotationhttps://api.ddog-gov.com/api/v2/annotationhttps://api.us2.ddog-gov.com/api/v2/annotation

Overview

Returns a flat list of annotations matching the given page, time window, and optional widget filter.

Arguments

Query Strings

Name
Type
Description
page_id [required]
string

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

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.

widget_id
string

Optional widget ID to restrict results to annotations on a specific widget.

Response

OK

Response containing a list of annotations.

Field
Type
Description
data [required]
[object]

List of annotation resources.

Code Example

# Required query arguments
export page_id="dashboard:abc-def-xyz"
export start_time="1704067200000"
export end_time="1704153600000"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/annotation?page_id=${page_id}&start_time=${start_time}&end_time=${end_time}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export page_id="dashboard:abc-def-xyz"
export start_time="1704067200000"
export end_time="1704153600000"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/annotation?page_id=${page_id}&start_time=${start_time}&end_time=${end_time}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export page_id="dashboard:abc-def-xyz"
export start_time="1704067200000"
export end_time="1704153600000"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/annotation?page_id=${page_id}&start_time=${start_time}&end_time=${end_time}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export page_id="dashboard:abc-def-xyz"
export start_time="1704067200000"
export end_time="1704153600000"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/annotation?page_id=${page_id}&start_time=${start_time}&end_time=${end_time}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export page_id="dashboard:abc-def-xyz"
export start_time="1704067200000"
export end_time="1704153600000"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/annotation?page_id=${page_id}&start_time=${start_time}&end_time=${end_time}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export page_id="dashboard:abc-def-xyz"
export start_time="1704067200000"
export end_time="1704153600000"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/annotation?page_id=${page_id}&start_time=${start_time}&end_time=${end_time}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export page_id="dashboard:abc-def-xyz"
export start_time="1704067200000"
export end_time="1704153600000"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/annotation?page_id=${page_id}&start_time=${start_time}&end_time=${end_time}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export page_id="dashboard:abc-def-xyz"
export start_time="1704067200000"
export end_time="1704153600000"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/annotation?page_id=${page_id}&start_time=${start_time}&end_time=${end_time}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export page_id="dashboard:abc-def-xyz"
export start_time="1704067200000"
export end_time="1704153600000"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/annotation?page_id=${page_id}&start_time=${start_time}&end_time=${end_time}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"