--- title: List annotations description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Annotations --- # List annotations{% #list-annotations %} {% tab title="v2" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | --------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/annotation | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/annotation | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/annotation | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/annotation | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/annotation | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/annotation | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/annotation | | us5.datadoghq.com | GET https://api.us5.datadoghq.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 {% tab title="200" %} OK {% tab title="Model" %} Response containing a list of annotations. | Parent field | Field | Type | Description | | ------------ | ----------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | [object] | List of annotation resources. | | data | attributes [*required*] | object | Attributes of an annotation returned in a response. | | attributes | author_id [*required*] | string | Identifier of the user who created the annotation. | | attributes | color [*required*] | enum | Color used to render the annotation in the UI. Allowed enum values: `gray,blue,purple,green,yellow,red` | | attributes | created_at [*required*] | int64 | Creation time of the annotation in milliseconds since the Unix epoch. | | attributes | description [*required*] | string | User-defined text attached to the annotation. | | attributes | end_time [*required*] | int64 | End time of the annotation in milliseconds since the Unix epoch. Null for `pointInTime` annotations. | | attributes | modified_at [*required*] | int64 | Last modification time of the annotation in milliseconds since the Unix epoch. | | attributes | 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`). | | attributes | start_time [*required*] | int64 | Start time of the annotation in milliseconds since the Unix epoch. | | attributes | 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` | | attributes | widget_ids | [string] | IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page. | | data | id [*required*] | uuid | Unique identifier of the annotation. | | data | type [*required*] | enum | Annotation resource type. Allowed enum values: `annotation` | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "author_id": "00000000-0000-0000-0000-000000000000", "color": "blue", "created_at": 1704067200000, "description": "Deployed v2.3.1 to production.", "end_time": 1704070800000, "modified_at": 1704067200000, "page_id": "dashboard:abc-def-xyz", "start_time": 1704067200000, "type": "pointInTime", "widget_ids": [ "1234567890" ] }, "id": "00000000-0000-0000-0000-000000000000", "type": "annotation" } ] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="500" %} Internal Server Error {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Required query arguments export page_id="dashboard:abc-def-xyz" export start_time="1.7040672e+12" export end_time="1.7041536e+12" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/annotation?page_id=${page_id}&start_time=${start_time}&end_time=${end_time}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" {% /tab %}