Report Schedules

List dataset report schedules

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.

get/api/v2/reporting/dataset/{dataset_id}/schedules

Request

Path parameters

dataset_idstring required

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

Response

OK

Example response

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

Changes

Changes to this operation have not been checked yet.