--- title: "List report schedules" method: GET path: "/api/v2/reporting/schedule/list" tags: ["Report Schedules"] --- # List report schedules `GET /api/v2/reporting/schedule/list` ## Request - Base URL: `https://api.datadoghq.com` - URL: `https://api.datadoghq.com/api/v2/reporting/schedule/list` - Auth: API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY` List dashboard and integration dashboard report schedules for the organization. The response is paginated and can be filtered by title, author UUID, or recipients. Requires the `generate_dashboard_reports` permission. ## Query parameters - `page[limit]` integer - `page[offset]` integer - `filter[title]` string - `filter[author_uuid]` string, uuid - `filter[recipients]` string ## Response `200` OK - ReportScheduleListResponse: Response containing a list of report schedules. - `data` ReportScheduleListResponseData[], required: The list of report schedules. - `attributes` ReportScheduleListResponseAttributes, required: The configuration and derived state of a report schedule in a list response. - `delivery_format` 'pdf' | 'png' | 'pdf_and_png', nullable: The delivery format for dashboard report schedules, or `null` if not set. - `description` string, required: The description of the report. - `next_recurrence` integer, nullable, required: The Unix timestamp, in milliseconds, of the next scheduled delivery, or `null` if none is scheduled. - `recipients` string[], required: The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references). - `resource_id` string, required: The identifier of the resource rendered in the report. - `resource_type` 'dashboard' | 'integration_dashboard', required: The type of dashboard resource the report schedule targets. - `rrule` string, required: The recurrence rule for the schedule, expressed as an iCalendar `RRULE` string. - `status` 'active' | 'inactive', required: Whether the schedule is currently delivering reports (`active`) or paused (`inactive`). - `template_variables` ReportScheduleTemplateVariable[], required: The dashboard template variables applied when rendering the report. - `name` string, required: The name of the template variable. - `values` string[], required: The selected values for the template variable. - `timeframe` string, nullable, required: The relative timeframe of data included in the report, or `null` if not set. - `timezone` string, required: The IANA time zone identifier the recurrence rule is evaluated in. - `title` string, required: The title of the report. - `id` string, required: The unique identifier of the report schedule. - `relationships` ReportScheduleListResponseRelationships, required: Relationships for a report schedule in a list response. - `author` ReportScheduleAuthorRelationship, required: Relationship to the author of the report schedule. - `data` ReportScheduleAuthorRelationshipData, required: Relationship data for the author of the report schedule. - `id` string, required: The user UUID of the report schedule author. - `type` 'users', required: JSON:API resource type for the included report author. - `resource` ReportScheduleListResourceRelationship: Relationship to the report target resource. - `data` ReportScheduleListResourceRelationshipData, required: Relationship data for the report target resource. - `id` string, required: The resource identifier. - `type` 'resource', required: JSON:API resource type for an included report resource. - `type` 'schedule', required: JSON:API resource type for report schedules. - `included` ReportScheduleIncludedResource[]: Related resources included with the report schedules, such as authors and rendered resources. - union: A related resource included with a report schedule. - ReportScheduleAuthor: A user included as a related JSON:API resource. - `attributes` ReportScheduleAuthorAttributes, required: Attributes of the report author. - `email` string, nullable, required: The email address of the report author, or `null` if unavailable. - `name` string, nullable, required: The display name of the report author, or `null` if unavailable. - `id` string, required: The user UUID. - `type` 'users', required: JSON:API resource type for the included report author. - ReportScheduleResource: A report target resource included as a related JSON:API resource. - `attributes` ReportScheduleResourceAttributes, required: Attributes of an included report target resource. - `resource_type` 'dashboard' | 'integration_dashboard', required: The type of dashboard resource the report schedule targets. - `template_variables` ReportScheduleIndexTemplateVariable[], nullable: Template variable metadata from the dashboard resource, when available. - `available_values` string[], nullable: Available values for the template variable. - `defaults` string[], nullable: Default values for the template variable. - `name` string, nullable: The template variable name. - `prefix` string, nullable: The tag prefix for the template variable, when available. - `title` string, nullable: The title of the dashboard or integration dashboard resource, when available. - `id` string, required: The resource identifier. - `type` 'resource', required: JSON:API resource type for an included report resource. - `links` ReportScheduleListResponseLinks: Pagination links for navigating a report schedule list response. - `first` string, nullable: Link to the first page. - `last` string, nullable: Link to the last page, or `null` if it is unavailable. - `next` string, nullable: Link to the next page, or `null` if it is unavailable. - `prev` string, nullable: Link to the previous page, or `null` if it is unavailable. - `self` string, nullable: Link to the current page. - `meta` ReportScheduleListResponseMeta: Metadata for a paginated report schedule list response. - `pagination` ReportScheduleListResponsePagination: Offset and limit pagination metadata for a report schedule list response. - `first_offset` integer: The first offset. - `last_offset` integer, nullable: The last offset when the total count is known, or `null` if it is unavailable. - `limit` integer: The maximum number of schedules returned. - `next_offset` integer: The next offset. - `offset` integer: The current offset. - `prev_offset` integer: The previous offset. - `total` integer: The total number of matching schedules. - `type` 'offset_limit': The pagination type. ## Other responses - `400`: Bad Request - `403`: Forbidden - `404`: Not Found - `429`: Too many requests --- [API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/da68bf029e4c?raw)