GET https://api.ap1.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid} https://api.ap2.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid} https://api.datadoghq.eu/api/v2/reporting/schedule/{schedule_uuid} https://api.ddog-gov.com/api/v2/reporting/schedule/{schedule_uuid} https://api.us2.ddog-gov.com/api/v2/reporting/schedule/{schedule_uuid} https://api.uk1.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid} https://api.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid} https://api.us3.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid} https://api.us5.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}
Overview Get a report schedule by its unique identifier.
Requires a reporting read permission appropriate to the targeted resource type.
Arguments Path Parameters The unique identifier of the report schedule to fetch.
Response OK
Response containing a single report schedule.
Expand All
The JSON:API data object representing a report schedule.
The configuration and derived state of a report schedule.
The delivery format for dashboard report schedules, or null if not set.
Allowed enum values: pdf,png,pdf_and_png
The description of the report.
next_recurrence [required ]
The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.
The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).
The identifier of the resource rendered in the report.
The type of dashboard resource the report schedule targets.
Allowed enum values: dashboard,integration_dashboard
The recurrence rule for the schedule, expressed as an iCalendar RRULE string.
Whether the schedule is currently delivering reports (active) or paused (inactive).
Allowed enum values: active,inactive
The identifier of the dashboard tab rendered in the report, or null if not set.
template_variables [required ]
The dashboard template variables applied when rendering the report.
The name of the template variable.
The selected values for the template variable.
The relative timeframe of data included in the report, or null if not set.
The IANA time zone identifier the recurrence rule is evaluated in.
The unique identifier of the report schedule.
Relationships for the report schedule.
Relationship to the author of the report schedule.
Relationship data for the author of the report schedule.
The user UUID of the report schedule author.
JSON:API resource type for the included report author.
Allowed enum values: users
JSON:API resource type for report schedules.
Allowed enum values: schedule
Related resources included with the report schedule, such as the author.
A user included as a related JSON:API resource.
Attributes of the report author.
The email address of the report author, or null if unavailable.
The display name of the report author, or null if unavailable.
JSON:API resource type for the included report author.
Allowed enum values: users
A report target resource included as a related JSON:API resource.
Attributes of an included report target resource.
The type of dashboard resource the report schedule targets.
Allowed enum values: dashboard,integration_dashboard
Template variable metadata from the dashboard resource, when available.
Available values for the template variable.
Default values for the template variable.
The template variable name.
The tag prefix for the template variable, when available.
The title of the dashboard or integration dashboard resource, when available.
JSON:API resource type for an included report resource.
Allowed enum values: resource
{
"data" : {
"attributes" : {
"delivery_format" : "pdf" ,
"description" : "Weekly summary of infrastructure health." ,
"next_recurrence" : 1780923600000 ,
"recipients" : [
"[email protected] " ,
"slack:T01234567.C01234567.alerts" ,
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:[email protected] "
],
"resource_id" : "abc-def-ghi" ,
"resource_type" : "dashboard" ,
"rrule" : "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0" ,
"status" : "active" ,
"tab_id" : "66666666-7777-8888-9999-000000000000" ,
"template_variables" : [
{
"name" : "env" ,
"values" : [
"prod"
]
}
],
"timeframe" : "1w" ,
"timezone" : "America/New_York" ,
"title" : "Weekly Infrastructure Report"
},
"id" : "11111111-2222-3333-4444-555555555555" ,
"relationships" : {
"author" : {
"data" : {
"id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" ,
"type" : "users"
}
}
},
"type" : "schedule"
},
"included" : [
{
"attributes" : {
"email" : "[email protected] " ,
"name" : "Example User"
},
"id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" ,
"type" : "users"
}
]
} Bad Request
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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"
}
]
} Not Found
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# Path parameters export schedule_uuid = "11111111-2222-3333-4444-555555555555" # 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/reporting/schedule/${schedule_uuid} " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
Get a report schedule returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.report_schedules_api import ReportSchedulesApi
from uuid import UUID
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = ReportSchedulesApi ( api_client )
response = api_instance . get_report_schedule (
schedule_uuid = UUID ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ),
)
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.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" python3 "example.py"
# Get a report schedule returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V2 :: ReportSchedulesAPI . new
p api_instance . get_report_schedule ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" )
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" rb "example.rb"
// Get a report schedule 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"
"github.com/google/uuid"
)
func main () {
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewReportSchedulesApi ( apiClient )
resp , r , err := api . GetReportSchedule ( ctx , uuid . MustParse ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ))
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `ReportSchedulesApi.GetReportSchedule`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `ReportSchedulesApi.GetReportSchedule`:\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.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" go run "main.go"
// Get a report schedule returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.ReportSchedulesApi ;
import com.datadog.api.client.v2.model.ReportScheduleResponse ;
import java.util.UUID ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
ReportSchedulesApi apiInstance = new ReportSchedulesApi ( defaultClient );
try {
ReportScheduleResponse result =
apiInstance . getReportSchedule ( UUID . fromString ( "11111111-2222-3333-4444-555555555555" ));
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling ReportSchedulesApi#getReportSchedule" );
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.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" java "Example.java"
// Get a report schedule returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_report_schedules ::ReportSchedulesAPI ;
use uuid ::Uuid ;
#[tokio::main]
async fn main () {
let configuration = datadog ::Configuration ::new ();
let api = ReportSchedulesAPI ::with_config ( configuration );
let resp = api
. get_report_schedule (
Uuid ::parse_str ( "00000000-0000-0000-0000-000000000000" ). expect ( "invalid UUID" ),
)
. 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.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" cargo run
/**
* Get a report schedule returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v2 . ReportSchedulesApi ( configuration );
const params : v2.ReportSchedulesApiGetReportScheduleRequest = {
scheduleUuid : "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ,
};
apiInstance
. getReportSchedule ( params )
. then (( data : v2.ReportScheduleResponse ) => {
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.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" tsc "example.ts"