Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Report Schedules

Get report schedules for a resource

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

get/api/v2/reporting/schedule/{resource_type}/{resource_id}

Path parameters

resource_type'dashboard' | 'integration_dashboard' required

The type of dashboard resource the report schedule targets.

Example:dashboard

The type of resource to fetch report schedules for.

resource_idstring required

The identifier of the resource to fetch report schedules for.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "delivery_format": "pdf",
        "description": "Weekly summary of infrastructure health.",
        "next_recurrence": 1780923600000,
        "recipients": [
          "user@example.com",
          "slack:T01234567.C01234567.alerts",
          "teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"
        ],
        "resource_id": "abc-def-ghi",
        "resource_type": "dashboard",
        "rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
        "status": "active",
        "template_variables": [
          {
            "name": "env",
            "values": [
              "prod"
            ]
          }
        ],
        "timeframe": "1w",
        "timezone": "America/New_York",
        "title": "Weekly Infrastructure Report"
      },
      "id": "11111111-2222-3333-4444-555555555555",
      "relationships": {
        "author": {
          "data": {
            "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
            "type": "users"
          }
        },
        "resource": {
          "data": {
            "id": "abc-def-ghi",
            "type": "resource"
          }
        }
      },
      "type": "schedule"
    }
  ],
  "included": [
    {
      "attributes": {
        "email": "user@example.com",
        "name": "Example User"
      },
      "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "users"
    }
  ],
  "links": {
    "first": "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=0&page[limit]=25",
    "last": "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=0&page[limit]=25",
    "next": "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=25&page[limit]=25",
    "prev": "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=0&page[limit]=25",
    "self": "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[limit]=25"
  },
  "meta": {
    "pagination": {
      "limit": 25,
      "next_offset": 25,
      "total": 1,
      "type": "offset_limit"
    }
  }
}