v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

dashboardManagement

List all dashboard report schedules.

List all dashboard report schedules created by the user.

get/v1/dashboards/reportSchedules

Query parameters

dashboardIdstring

UUID of the dashboard that the report shedules are associated with.

limitinteger

Limit the number of dashboard report schedules returned in the response. The number of dashboard report schedules returned may be less than the limit.

tokenstring

Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

Response

Paginated list of dashboard report schedules created by the user.

nextstring

Next continuation token. token is set to null when no more pages are left.

Example response

{
  "reportSchedules": [
    {
      "dashboardId": "B23OjNs5ZCyn5VdMwOBoLo3PjgRnJSAlNTKEDAcpuDG2CIgRe9KFXMofm2H2",
      "timeRange": {
        "type": "BeginBoundedTimeRange",
        "from": {
          "type": "RelativeTimeRangeBoundary",
          "relativeTime": "-15m"
        }
      },
      "reportFormat": "Pdf",
      "scheduleType": "1Day",
      "cronExpression": "0 0/15 * * * ? *",
      "timeZone": "America/Los_Angeles",
      "emailNotification": {
        "recipients": [
          "john@doe.com"
        ],
        "subject": "Sample Email Subject",
        "messageBody": "Sample Email Message Body",
        "timeZone": "America/Los_Angeles"
      },
      "theme": "Light",
      "exportWidth": 1500,
      "scheduleId": "RdQHYPh2jxoS90DXtKfA7nAJV2rsQ9BncpfY7IkjNzQWi52ug85W7r6Rrmtd"
    }
  ],
  "next": "GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc"
}