--- title: Get report schedules for a resource description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Report Schedules --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). # Get report schedules for a resource{% #get-report-schedules-for-a-resource %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/reporting/schedule/{resource_type}/{resource_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/reporting/schedule/{resource_type}/{resource_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/reporting/schedule/{resource_type}/{resource_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/reporting/schedule/{resource_type}/{resource_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/reporting/schedule/{resource_type}/{resource_id} | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/reporting/schedule/{resource_type}/{resource_id} | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/reporting/schedule/{resource_type}/{resource_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/reporting/schedule/{resource_type}/{resource_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/reporting/schedule/{resource_type}/{resource_id} | ### Overview Get all report schedules that target a dashboard or integration dashboard resource. Requires a reporting read permission appropriate to the targeted resource type. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------------- | ------ | ------------------------------------------------------------- | | resource_type [*required*] | string | The type of resource to fetch report schedules for. | | resource_id [*required*] | string | The identifier of the resource to fetch report schedules for. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing a list of report schedules. | Parent field | Field | Type | Description | | ------------------ | ------------------------------------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | [object] | The list of report schedules. | | data | attributes [*required*] | object | The configuration and derived state of a report schedule in a list response. | | attributes | delivery_format | enum | The delivery format for dashboard report schedules, or `null` if not set. Allowed enum values: `pdf,png,pdf_and_png` | | attributes | description [*required*] | string | The description of the report. | | attributes | next_recurrence [*required*] | int64 | The Unix timestamp, in milliseconds, of the next scheduled delivery, or `null` if none is scheduled. | | attributes | recipients [*required*] | [string] | The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references). | | attributes | resource_id [*required*] | string | The identifier of the resource rendered in the report. | | attributes | resource_type [*required*] | enum | The type of dashboard resource the report schedule targets. Allowed enum values: `dashboard,integration_dashboard` | | attributes | rrule [*required*] | string | The recurrence rule for the schedule, expressed as an iCalendar `RRULE` string. | | attributes | status [*required*] | enum | Whether the schedule is currently delivering reports (`active`) or paused (`inactive`). Allowed enum values: `active,inactive` | | attributes | template_variables [*required*] | [object] | The dashboard template variables applied when rendering the report. | | template_variables | name [*required*] | string | The name of the template variable. | | template_variables | values [*required*] | [string] | The selected values for the template variable. | | attributes | timeframe [*required*] | string | The relative timeframe of data included in the report, or `null` if not set. | | attributes | timezone [*required*] | string | The IANA time zone identifier the recurrence rule is evaluated in. | | attributes | title [*required*] | string | The title of the report. | | data | id [*required*] | string | The unique identifier of the report schedule. | | data | relationships [*required*] | object | Relationships for a report schedule in a list response. | | relationships | author [*required*] | object | Relationship to the author of the report schedule. | | author | data [*required*] | object | Relationship data for the author of the report schedule. | | data | id [*required*] | string | The user UUID of the report schedule author. | | data | type [*required*] | enum | JSON:API resource type for the included report author. Allowed enum values: `users` | | relationships | resource | object | Relationship to the report target resource. | | resource | data [*required*] | object | Relationship data for the report target resource. | | data | id [*required*] | string | The resource identifier. | | data | type [*required*] | enum | JSON:API resource type for an included report resource. Allowed enum values: `resource` | | data | type [*required*] | enum | JSON:API resource type for report schedules. Allowed enum values: `schedule` | | | included | [ ] | Related resources included with the report schedules, such as authors and rendered resources. | | included | Option 1 | object | A user included as a related JSON:API resource. | | Option 1 | attributes [*required*] | object | Attributes of the report author. | | attributes | email [*required*] | string | The email address of the report author, or `null` if unavailable. | | attributes | name [*required*] | string | The display name of the report author, or `null` if unavailable. | | Option 1 | id [*required*] | string | The user UUID. | | Option 1 | type [*required*] | enum | JSON:API resource type for the included report author. Allowed enum values: `users` | | included | Option 2 | object | A report target resource included as a related JSON:API resource. | | Option 2 | attributes [*required*] | object | Attributes of an included report target resource. | | attributes | resource_type [*required*] | enum | The type of dashboard resource the report schedule targets. Allowed enum values: `dashboard,integration_dashboard` | | attributes | template_variables | [object] | Template variable metadata from the dashboard resource, when available. | | template_variables | available_values | [string] | Available values for the template variable. | | template_variables | defaults | [string] | Default values for the template variable. | | template_variables | name | string | The template variable name. | | template_variables | prefix | string | The tag prefix for the template variable, when available. | | attributes | title | string | The title of the dashboard or integration dashboard resource, when available. | | Option 2 | id [*required*] | string | The resource identifier. | | Option 2 | type [*required*] | enum | JSON:API resource type for an included report resource. Allowed enum values: `resource` | | | links | object | Pagination links for navigating a report schedule list response. | | links | first | string | Link to the first page. | | links | last | string | Link to the last page, or `null` if it is unavailable. | | links | next | string | Link to the next page, or `null` if it is unavailable. | | links | prev | string | Link to the previous page, or `null` if it is unavailable. | | links | self | string | Link to the current page. | | | meta | object | Metadata for a paginated report schedule list response. | | meta | pagination | object | Offset and limit pagination metadata for a report schedule list response. | | pagination | first_offset | int64 | The first offset. | | pagination | last_offset | int64 | The last offset when the total count is known, or `null` if it is unavailable. | | pagination | limit | int64 | The maximum number of schedules returned. | | pagination | next_offset | int64 | The next offset. | | pagination | offset | int64 | The current offset. | | pagination | prev_offset | int64 | The previous offset. | | pagination | total | int64 | The total number of matching schedules. | | pagination | type | enum | The pagination type. Allowed enum values: `offset_limit` | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "delivery_format": "pdf", "description": "Weekly summary of infrastructure health.", "next_recurrence": 1780923600000, "recipients": [ "user@example.com", "slack:T01234567.C01234567.alerts", "teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2" ], "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", "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" } }, "resource": { "data": { "id": "abc-def-ghi", "type": "resource" } } }, "type": "schedule" } ], "included": [ { "attributes": { "email": "user@example.com", "name": "Example User" }, "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "type": "users" } ], "links": { "first": "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=0\u0026page[limit]=25", "last": "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=0\u0026page[limit]=25", "next": "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=25\u0026page[limit]=25", "prev": "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=0\u0026page[limit]=25", "self": "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[limit]=25" }, "meta": { "pagination": { "first_offset": 0, "last_offset": 0, "limit": 25, "next_offset": 25, "offset": 0, "prev_offset": 0, "total": 1, "type": "offset_limit" } } } ``` {% /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="404" %} Not Found {% 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 %} ### Code Example ##### \# Path parameters export resource_type="dashboard" export resource_id="abc-def-ghi" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/reporting/schedule/${resource_type}/${resource_id}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get report schedules for a resource returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.report_schedules_api import ReportSchedulesApi from datadog_api_client.v2.model.report_schedule_resource_type import ReportScheduleResourceType configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = ReportSchedulesApi(api_client) response = api_instance.get_report_schedules_for_resource( resource_type=ReportScheduleResourceType.DASHBOARD, resource_id="resource_id", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get report schedules for a resource returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::ReportSchedulesAPI.new p api_instance.get_report_schedules_for_resource(ReportScheduleResourceType::DASHBOARD, "resource_id") ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get report schedules for a resource 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() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewReportSchedulesApi(apiClient) resp, r, err := api.GetReportSchedulesForResource(ctx, datadogV2.REPORTSCHEDULERESOURCETYPE_DASHBOARD, "resource_id") if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ReportSchedulesApi.GetReportSchedulesForResource`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `ReportSchedulesApi.GetReportSchedulesForResource`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get report schedules for a resource 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.ReportScheduleListResponse; import com.datadog.api.client.v2.model.ReportScheduleResourceType; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); ReportSchedulesApi apiInstance = new ReportSchedulesApi(defaultClient); try { ReportScheduleListResponse result = apiInstance.getReportSchedulesForResource( ReportScheduleResourceType.DASHBOARD, "abc-def-ghi"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ReportSchedulesApi#getReportSchedulesForResource"); 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](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get report schedules for a resource returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_report_schedules::ReportSchedulesAPI; use datadog_api_client::datadogV2::model::ReportScheduleResourceType; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = ReportSchedulesAPI::with_config(configuration); let resp = api .get_report_schedules_for_resource( ReportScheduleResourceType::DASHBOARD, "resource_id".to_string(), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get report schedules for a resource returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.ReportSchedulesApi(configuration); const params: v2.ReportSchedulesApiGetReportSchedulesForResourceRequest = { resourceType: "dashboard", resourceId: "resource_id", }; apiInstance .getReportSchedulesForResource(params) .then((data: v2.ReportScheduleListResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}