Attributes of an annotation returned in a 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.
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.
{"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"}]}
"""
List annotations returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.annotations_apiimportAnnotationsApi# there is a valid "annotation" in the systemANNOTATION_DATA_ATTRIBUTES_PAGE_ID=environ["ANNOTATION_DATA_ATTRIBUTES_PAGE_ID"]configuration=Configuration()configuration.unstable_operations["list_annotations"]=TruewithApiClient(configuration)asapi_client:api_instance=AnnotationsApi(api_client)response=api_instance.list_annotations(page_id=ANNOTATION_DATA_ATTRIBUTES_PAGE_ID,start_time=1704067200000,end_time=1704153600000,)print(response)
# List annotations returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.list_annotations".to_sym]=trueendapi_instance=DatadogAPIClient::V2::AnnotationsAPI.new# there is a valid "annotation" in the systemANNOTATION_DATA_ATTRIBUTES_PAGE_ID=ENV["ANNOTATION_DATA_ATTRIBUTES_PAGE_ID"]papi_instance.list_annotations(ANNOTATION_DATA_ATTRIBUTES_PAGE_ID,1704067200000,1704153600000)
// List annotations returns "OK" responsepackagemainimport("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")funcmain(){// there is a valid "annotation" in the systemAnnotationDataAttributesPageID:=os.Getenv("ANNOTATION_DATA_ATTRIBUTES_PAGE_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.ListAnnotations",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewAnnotationsApi(apiClient)resp,r,err:=api.ListAnnotations(ctx,AnnotationDataAttributesPageID,1704067200000,1704153600000,*datadogV2.NewListAnnotationsOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `AnnotationsApi.ListAnnotations`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `AnnotationsApi.ListAnnotations`:\n%s\n",responseContent)}
// List annotations returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.AnnotationsApi;importcom.datadog.api.client.v2.model.AnnotationsResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setUnstableOperationEnabled("v2.listAnnotations",true);AnnotationsApiapiInstance=newAnnotationsApi(defaultClient);// there is a valid "annotation" in the systemStringANNOTATION_DATA_ATTRIBUTES_PAGE_ID=System.getenv("ANNOTATION_DATA_ATTRIBUTES_PAGE_ID");try{AnnotationsResponseresult=apiInstance.listAnnotations(ANNOTATION_DATA_ATTRIBUTES_PAGE_ID,1704067200000L,1704153600000L);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling AnnotationsApi#listAnnotations");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// List annotations returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_annotations::AnnotationsAPI;usedatadog_api_client::datadogV2::api_annotations::ListAnnotationsOptionalParams;#[tokio::main]asyncfnmain(){// there is a valid "annotation" in the system
letannotation_data_attributes_page_id=std::env::var("ANNOTATION_DATA_ATTRIBUTES_PAGE_ID").unwrap();letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.ListAnnotations",true);letapi=AnnotationsAPI::with_config(configuration);letresp=api.list_annotations(annotation_data_attributes_page_id.clone(),1704067200000,1704153600000,ListAnnotationsOptionalParams::default(),).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
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
/**
* List annotations returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.listAnnotations"]=true;constapiInstance=newv2.AnnotationsApi(configuration);// there is a valid "annotation" in the system
constANNOTATION_DATA_ATTRIBUTES_PAGE_ID=process.env.ANNOTATION_DATA_ATTRIBUTES_PAGE_IDasstring;constparams: v2.AnnotationsApiListAnnotationsRequest={pageId: ANNOTATION_DATA_ATTRIBUTES_PAGE_ID,startTime: 1704067200000,endTime: 1704153600000,};apiInstance.listAnnotations(params).then((data: v2.AnnotationsResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));