For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/api/latest/report-schedules/list-dataset-report-schedules.md. A documentation index is available at /llms.txt.

List dataset report schedules

GET https://api.ap1.datadoghq.com/api/v2/reporting/dataset/{dataset_id}/scheduleshttps://api.ap2.datadoghq.com/api/v2/reporting/dataset/{dataset_id}/scheduleshttps://api.datadoghq.eu/api/v2/reporting/dataset/{dataset_id}/scheduleshttps://api.ddog-gov.com/api/v2/reporting/dataset/{dataset_id}/scheduleshttps://api.us2.ddog-gov.com/api/v2/reporting/dataset/{dataset_id}/scheduleshttps://api.uk1.datadoghq.com/api/v2/reporting/dataset/{dataset_id}/scheduleshttps://api.datadoghq.com/api/v2/reporting/dataset/{dataset_id}/scheduleshttps://api.us3.datadoghq.com/api/v2/reporting/dataset/{dataset_id}/scheduleshttps://api.us5.datadoghq.com/api/v2/reporting/dataset/{dataset_id}/schedules

Overview

Retrieve all report schedules for a given published dataset. Returns report schedules belonging to the authenticated user’s organization that target the specified dataset. Requires the generate_log_reports or manage_log_reports permission.

Arguments

Path Parameters

Name

Type

Description

dataset_id [required]

string

The identifier of the published dataset to retrieve report schedules for.

Response

OK

Response containing a list of report schedules for a published dataset.

Expand All

Field

Type

Description

data [required]

[object]

A list of report schedules for the dataset.

attributes [required]

object

The configuration and derived state of a report schedule for a published dataset.

cell_id [required]

string

The identifier of the notebook cell that published the dataset, or null if not set.

dataset_id [required]

string

The identifier of the dataset, or null if not set.

description [required]

string

The description of the report.

file_row_limit [required]

int64

The maximum number of rows included in the attached CSV file, or null if not set.

inline_row_limit [required]

int64

The maximum number of rows included inline in the email body, or null if not set.

next_recurrence [required]

int64

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

notebook_id [required]

int64

The identifier of the notebook containing the dataset cell, or null if not set.

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 widget containing the dataset.

resource_type [required]

enum

The type of resource targeted by a dataset report schedule. Allowed enum values: widget_dataset_list

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

timeframe [required]

string

The relative timeframe of data included in the report.

timezone [required]

string

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

title [required]

string

The title of the report.

id [required]

uuid

The unique identifier of the dataset report schedule.

relationships [required]

object

Relationships for the report schedule.

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

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.

<type=users>

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

<type=resource>

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

{
  "data": [
    {
      "attributes": {
        "cell_id": "sevhjcis",
        "dataset_id": "MW5vdGVib29rX2NlbGw6ZDI0ZTM2MWMtZDFlNC00NDYwLWIyOWUtNTg3YTczMzA3MDFm",
        "description": "This is a scheduled notebook dataset report.",
        "file_row_limit": 5000,
        "inline_row_limit": 10,
        "next_recurrence": 1725859200000,
        "notebook_id": 1,
        "recipients": [
          "test@datadoghq.com"
        ],
        "resource_id": "aaaabbbb-1111-2222-3333-444455556666",
        "resource_type": "widget_dataset_list",
        "rrule": "DTSTART;TZID=America/New_York:20240912T090000\nRRULE:FREQ=DAILY;BYHOUR=9;BYMINUTE=0",
        "status": "active",
        "timeframe": "calendar_day",
        "timezone": "America/New_York",
        "title": "My Cool Dataset Report"
      },
      "id": "e1234567-1234-1234-1234-123456789012",
      "relationships": {
        "author": {
          "data": {
            "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
            "type": "users"
          }
        }
      },
      "type": "schedule"
    }
  ],
  "included": [
    {
      "attributes": {
        "email": "user@example.com",
        "name": "Example User"
      },
      "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "users"
    }
  ]
}

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 dataset_id="MW5vdGVib29rX2NlbGw6ZDI0ZTM2MWMtZDFlNC00NDYwLWIyOWUtNTg3YTczMzA3MDFm"
# 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/dataset/${dataset_id}/schedules" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
List dataset report schedules returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.report_schedules_api import ReportSchedulesApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = ReportSchedulesApi(api_client)
    response = api_instance.list_dataset_report_schedules(
        dataset_id="dataset_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"
# List dataset report schedules returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::ReportSchedulesAPI.new
p api_instance.list_dataset_report_schedules("dataset_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"
// List dataset report schedules 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.ListDatasetReportSchedules(ctx, "dataset_id")

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReportSchedulesApi.ListDatasetReportSchedules`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `ReportSchedulesApi.ListDatasetReportSchedules`:\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"
// List dataset report schedules 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.DatasetReportScheduleListResponse;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    ReportSchedulesApi apiInstance = new ReportSchedulesApi(defaultClient);

    try {
      DatasetReportScheduleListResponse result =
          apiInstance.listDatasetReportSchedules(
              "MW5vdGVib29rX2NlbGw6ZDI0ZTM2MWMtZDFlNC00NDYwLWIyOWUtNTg3YTczMzA3MDFm");
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReportSchedulesApi#listDatasetReportSchedules");
      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"
// List dataset report schedules returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_report_schedules::ReportSchedulesAPI;

#[tokio::main]
async fn main() {
    let configuration = datadog::Configuration::new();
    let api = ReportSchedulesAPI::with_config(configuration);
    let resp = api
        .list_dataset_report_schedules("dataset_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
/**
 * List dataset report schedules returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v2.ReportSchedulesApi(configuration);

const params: v2.ReportSchedulesApiListDatasetReportSchedulesRequest = {
  datasetId: "dataset_id",
};

apiInstance
  .listDatasetReportSchedules(params)
  .then((data: v2.DatasetReportScheduleListResponse) => {
    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"