Class ReportSchedulesApi

Create a new scheduled report. A schedule renders a dashboard or integration dashboard on a recurring cadence and delivers it to the configured recipients over email, Slack, or Microsoft Teams. Requires the generate_dashboard_reports permission.

Delete a report schedule by its unique identifier. The response returns the deleted schedule. Requires a reporting write permission appropriate to the targeted resource type and schedule ownership.

Get a report schedule by its unique identifier. Requires a reporting read permission appropriate to the targeted resource type.

Get all report schedules that target a dashboard or integration dashboard resource. Requires a reporting read permission appropriate to the targeted resource type.

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.

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.

Update an existing scheduled report by its identifier. The editable attributes are replaced with the supplied values; the targeted resource (resource_id and resource_type) cannot be changed after creation. Requires the generate_dashboard_reports permission and schedule ownership.

Initiate a one-off, print-only report for a dashboard or integration dashboard. The report is rendered as a PDF and made available for download through the URL returned in the response. Requires a reporting permission appropriate to the targeted resource type.

Activate or pause a report schedule by setting its status to active or inactive. Requires a reporting write permission appropriate to the targeted resource type and schedule ownership.