Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 UK1 US1-FED US2-FED

Get report schedules for a resource

copy Copy pageCopied

GET https://api.ap1.datadoghq.com/api/v2/reporting/schedule/{resource_type}/{resource_id}https://api.ap2.datadoghq.com/api/v2/reporting/schedule/{resource_type}/{resource_id}https://api.datadoghq.eu/api/v2/reporting/schedule/{resource_type}/{resource_id}https://api.ddog-gov.com/api/v2/reporting/schedule/{resource_type}/{resource_id}https://api.us2.ddog-gov.com/api/v2/reporting/schedule/{resource_type}/{resource_id}https://api.uk1.datadoghq.com/api/v2/reporting/schedule/{resource_type}/{resource_id}https://api.datadoghq.com/api/v2/reporting/schedule/{resource_type}/{resource_id}https://api.us3.datadoghq.com/api/v2/reporting/schedule/{resource_type}/{resource_id}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

OK

Response containing a list of report schedules.

Expand All

Field

Type

Description

data [required]

[object]

The list of report schedules.

attributes [required]

object

The configuration and derived state of a report schedule in a list response.

delivery_format

enum

The delivery format for dashboard report schedules, or null if not set. Allowed enum values: pdf,png,pdf_and_png

description [required]

string

The description of the report.

next_recurrence [required]

int64

The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.

recipients [required]

[string]

The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).

resource_id [required]

string

The identifier of the resource rendered in the report.

resource_type [required]

enum

The type of dashboard resource the report schedule targets. Allowed enum values: dashboard,integration_dashboard

rrule [required]

string

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

status [required]

enum

Whether the schedule is currently delivering reports (active) or paused (inactive). Allowed enum values: active,inactive

template_variables [required]

[object]

The dashboard template variables applied when rendering the report.

name [required]

string

The name of the template variable.

values [required]

[string]

The selected values for the template variable.

timeframe [required]

string

The relative timeframe of data included in the report, or null if not set.

timezone [required]

string

The IANA time zone identifier the recurrence rule is evaluated in.

title [required]

string

The title of the report.

id [required]

string

The unique identifier of the report schedule.

relationships [required]

object

Relationships for a report schedule in a list response.

author [required]

object

Relationship to the author of the report schedule.

data [required]

object

Relationship data for the author of the report schedule.

id [required]

string

The user UUID of the report schedule author.

type [required]

enum

JSON:API resource type for the included report author. Allowed enum values: users

resource

object

Relationship to the report target resource.

data [required]

object

Relationship data for the report target resource.

id [required]

string

The resource identifier.

type [required]

enum

JSON:API resource type for an included report resource. Allowed enum values: resource

type [required]

enum

JSON:API resource type for report schedules. Allowed enum values: schedule

included

[ <oneOf>]

Related resources included with the report schedules, such as authors and rendered resources.

Option 1

object

A user included as a related JSON:API resource.

attributes [required]

object

Attributes of the report author.

email [required]

string

The email address of the report author, or null if unavailable.

name [required]

string

The display name of the report author, or null if unavailable.

id [required]

string

The user UUID.

type [required]

enum

JSON:API resource type for the included report author. Allowed enum values: users

Option 2

object

A report target resource included as a related JSON:API resource.

attributes [required]

object

Attributes of an included report target resource.

resource_type [required]

enum

The type of dashboard resource the report schedule targets. Allowed enum values: dashboard,integration_dashboard

template_variables

[object]

Template variable metadata from the dashboard resource, when available.

available_values

[string]

Available values for the template variable.

defaults

[string]

Default values for the template variable.

name

string

The template variable name.

prefix

string

The tag prefix for the template variable, when available.

title

string

The title of the dashboard or integration dashboard resource, when available.

id [required]

string

The resource identifier.

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.

first

string

Link to the first page.

last

string

Link to the last page, or null if it is unavailable.

next

string

Link to the next page, or null if it is unavailable.

prev

string

Link to the previous page, or null if it is unavailable.

self

string

Link to the current page.

meta

object

Metadata for a paginated report schedule list response.

pagination

object

Offset and limit pagination metadata for a report schedule list response.

first_offset

int64

The first offset.

last_offset

int64

The last offset when the total count is known, or null if it is unavailable.

limit

int64

The maximum number of schedules returned.

next_offset

int64

The next offset.

offset

int64

The current offset.

prev_offset

int64

The previous offset.

total

int64

The total number of matching schedules.

type

enum

The pagination type. Allowed enum values: offset_limit

{
  "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"
    }
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export resource_type="dashboard"
export resource_id="abc-def-ghi"
# 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/${resource_type}/${resource_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

                
"""
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 and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# 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 and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// 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 and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// 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 and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// 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 and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
 * 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 and then save the example to example.ts and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"