report_dataset_schedules

Creates, updates, deletes, gets or lists a report_dataset_schedules resource.

Overview

Name	report_dataset_schedules
Type	Resource
Id	datadog.dashboards.report_dataset_schedules

Fields

The following fields are returned by SELECT queries:

list_dataset_report_schedules

Name	Datatype	Description
id	string (uuid)	The unique identifier of the dataset report schedule. (example: e1234567-1234-1234-1234-123456789012)
attributes	object	The configuration and derived state of a report schedule for a published dataset.
relationships	object	Relationships for the report schedule.
type	string	JSON:API resource type for report schedules. (schedule) (example: schedule)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_dataset_report_schedules	select	dataset_id		Retrieve all report schedules for a given published dataset.<br />Returns report schedules belonging to the authenticated user's organization that target the specified dataset.<br />Requires the generate_log_reports or manage_log_reports permission.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dataset_id	string	The identifier of the published dataset to retrieve report schedules for. (example: MW5vdGVib29rX2NlbGw6ZDI0ZTM2MWMtZDFlNC00NDYwLWIyOWUtNTg3YTczMzA3MDFm)
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.

SELECT examples

list_dataset_report_schedules

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

SELECT
id,
attributes,
relationships,
type
FROM datadog.dashboards.report_dataset_schedules
WHERE dataset_id = '{{ dataset_id }}' -- required
;