diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 3361b2f656d..da3c11741c6 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -10931,6 +10931,36 @@ menu: unstable: - v2 order: 5 + - name: Data Observability + url: /api/latest/data-observability/ + identifier: data-observability + generated: true + - name: Run a data observability monitor + url: /api/latest/data-observability/run-a-data-observability-monitor/ + identifier: data-observability-run-a-data-observability-monitor + parent: data-observability + generated: true + params: + versions: + - v2 + operationids: + - RunDataObservabilityMonitor + unstable: + - v2 + order: 1 + - name: Get data observability monitor run status + url: /api/latest/data-observability/get-data-observability-monitor-run-status/ + identifier: data-observability-get-data-observability-monitor-run-status + parent: data-observability + generated: true + params: + versions: + - v2 + operationids: + - GetDataObservabilityMonitorRunStatus + unstable: + - v2 + order: 2 - name: Datasets url: /api/latest/datasets/ identifier: datasets @@ -16222,6 +16252,18 @@ menu: url: /api/latest/report-schedules/ identifier: report-schedules generated: true + - name: Toggle a report schedule + url: /api/latest/report-schedules/toggle-a-report-schedule/ + identifier: report-schedules-toggle-a-report-schedule + parent: report-schedules + generated: true + params: + versions: + - v2 + operationids: + - ToggleReportSchedule + unstable: [] + order: 4 - name: Update a report schedule url: /api/latest/report-schedules/update-a-report-schedule/ identifier: report-schedules-update-a-report-schedule @@ -16235,6 +16277,54 @@ menu: unstable: - v2 order: 2 + - name: Get a report schedule + url: /api/latest/report-schedules/get-a-report-schedule/ + identifier: report-schedules-get-a-report-schedule + parent: report-schedules + generated: true + params: + versions: + - v2 + operationids: + - GetReportSchedule + unstable: [] + order: 3 + - name: Delete a report schedule + url: /api/latest/report-schedules/delete-a-report-schedule/ + identifier: report-schedules-delete-a-report-schedule + parent: report-schedules + generated: true + params: + versions: + - v2 + operationids: + - DeleteReportSchedule + unstable: [] + order: 7 + - name: Get report schedules for a resource + url: /api/latest/report-schedules/get-report-schedules-for-a-resource/ + identifier: report-schedules-get-report-schedules-for-a-resource + parent: report-schedules + generated: true + params: + versions: + - v2 + operationids: + - GetReportSchedulesForResource + unstable: [] + order: 5 + - name: List report schedules + url: /api/latest/report-schedules/list-report-schedules/ + identifier: report-schedules-list-report-schedules + parent: report-schedules + generated: true + params: + versions: + - v2 + operationids: + - ListReportSchedules + unstable: [] + order: 6 - name: Create a report schedule url: /api/latest/report-schedules/create-a-report-schedule/ identifier: report-schedules-create-a-report-schedule diff --git a/content/en/api/latest/data-observability/_index.md b/content/en/api/latest/data-observability/_index.md new file mode 100644 index 00000000000..21f1e2fdf1d --- /dev/null +++ b/content/en/api/latest/data-observability/_index.md @@ -0,0 +1,3 @@ +--- +title: Data Observability +--- diff --git a/content/en/api/latest/data-observability/get-data-observability-monitor-run-status/index.md b/content/en/api/latest/data-observability/get-data-observability-monitor-run-status/index.md new file mode 100644 index 00000000000..22308da38ce --- /dev/null +++ b/content/en/api/latest/data-observability/get-data-observability-monitor-run-status/index.md @@ -0,0 +1,3 @@ +--- +title: Get data observability monitor run status +--- diff --git a/content/en/api/latest/data-observability/run-a-data-observability-monitor/index.md b/content/en/api/latest/data-observability/run-a-data-observability-monitor/index.md new file mode 100644 index 00000000000..c6d9efc151b --- /dev/null +++ b/content/en/api/latest/data-observability/run-a-data-observability-monitor/index.md @@ -0,0 +1,3 @@ +--- +title: Run a data observability monitor +--- diff --git a/content/en/api/latest/report-schedules/delete-a-report-schedule/index.md b/content/en/api/latest/report-schedules/delete-a-report-schedule/index.md new file mode 100644 index 00000000000..dc3e3ac75bf --- /dev/null +++ b/content/en/api/latest/report-schedules/delete-a-report-schedule/index.md @@ -0,0 +1,3 @@ +--- +title: Delete a report schedule +--- diff --git a/content/en/api/latest/report-schedules/get-a-report-schedule/index.md b/content/en/api/latest/report-schedules/get-a-report-schedule/index.md new file mode 100644 index 00000000000..3a9edf69bba --- /dev/null +++ b/content/en/api/latest/report-schedules/get-a-report-schedule/index.md @@ -0,0 +1,3 @@ +--- +title: Get a report schedule +--- diff --git a/content/en/api/latest/report-schedules/get-report-schedules-for-a-resource/index.md b/content/en/api/latest/report-schedules/get-report-schedules-for-a-resource/index.md new file mode 100644 index 00000000000..8f7510ef23b --- /dev/null +++ b/content/en/api/latest/report-schedules/get-report-schedules-for-a-resource/index.md @@ -0,0 +1,3 @@ +--- +title: Get report schedules for a resource +--- diff --git a/content/en/api/latest/report-schedules/list-report-schedules/index.md b/content/en/api/latest/report-schedules/list-report-schedules/index.md new file mode 100644 index 00000000000..4b7f9cc1531 --- /dev/null +++ b/content/en/api/latest/report-schedules/list-report-schedules/index.md @@ -0,0 +1,3 @@ +--- +title: List report schedules +--- diff --git a/content/en/api/latest/report-schedules/toggle-a-report-schedule/index.md b/content/en/api/latest/report-schedules/toggle-a-report-schedule/index.md new file mode 100644 index 00000000000..49f910fc485 --- /dev/null +++ b/content/en/api/latest/report-schedules/toggle-a-report-schedule/index.md @@ -0,0 +1,3 @@ +--- +title: Toggle a report schedule +--- diff --git a/content/en/api/v2/data-observability/_index.md b/content/en/api/v2/data-observability/_index.md new file mode 100644 index 00000000000..c2391f40dda --- /dev/null +++ b/content/en/api/v2/data-observability/_index.md @@ -0,0 +1,4 @@ +--- +title: Data Observability +headless: true +--- diff --git a/content/en/api/v2/data-observability/examples.json b/content/en/api/v2/data-observability/examples.json new file mode 100644 index 00000000000..6a41124dae8 --- /dev/null +++ b/content/en/api/v2/data-observability/examples.json @@ -0,0 +1,112 @@ +{ + "GetDataObservabilityMonitorRunStatus": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "error_message": "run completed but produced no metric data", + "status": "pending" + }, + "id": "abc123def456", + "type": "monitor_run" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object for a data observability monitor run status response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a data observability monitor run status response.

\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

Error message describing why the monitor run failed. Only present when status is error.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of a data observability monitor run. \nAllowed enum values: pending,ok,warn,alert,error

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the monitor run.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API resource type for a data observability monitor run. \nAllowed enum values: monitor_run

default: monitor_run

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "RunDataObservabilityMonitor": { + "responses": { + "200": { + "json": { + "data": { + "id": "abc123def456", + "type": "monitor_run" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object returned when a data observability monitor run is triggered.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the monitor run.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API resource type for a data observability monitor run. \nAllowed enum values: monitor_run

default: monitor_run

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + } +} \ No newline at end of file diff --git a/content/en/api/v2/report-schedules/examples.json b/content/en/api/v2/report-schedules/examples.json index 5258f4b31c8..b33a41546df 100644 --- a/content/en/api/v2/report-schedules/examples.json +++ b/content/en/api/v2/report-schedules/examples.json @@ -15,7 +15,7 @@ ], "resource_id": "abc-def-ghi", "resource_type": "dashboard", - "rrule": "FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0", + "rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0", "status": "active", "tab_id": "66666666-7777-8888-9999-000000000000", "template_variables": [ @@ -52,7 +52,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data object representing a report schedule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The configuration and derived state of a report schedule.

\n
\n
\n
\n
\n
\n

delivery_format

\n
\n

enum

\n

The delivery format for dashboard report schedules, or null if not set. \nAllowed enum values: pdf,png,pdf_and_png

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the report.

\n
\n \n
\n
\n
\n
\n
\n

next_recurrence [required]

\n
\n

int64

\n

The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).

\n
\n \n
\n
\n
\n
\n
\n

resource_id [required]

\n
\n

string

\n

The identifier of the resource rendered in the report.

\n
\n \n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Whether the schedule is currently delivering reports (active) or paused (inactive). \nAllowed enum values: active,inactive

\n
\n \n
\n
\n
\n
\n
\n

tab_id [required]

\n
\n

string

\n

The identifier of the dashboard tab rendered in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

template_variables [required]

\n
\n

[object]

\n

The dashboard template variables applied when rendering the report.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template variable.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The selected values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeframe [required]

\n
\n

string

\n

The relative timeframe of data included in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

The IANA time zone identifier the recurrence rule is evaluated in.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the report.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the report schedule.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for the report schedule.

\n
\n
\n
\n
\n
\n

author [required]

\n
\n

object

\n

Relationship to the author of the report schedule.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship data for the author of the report schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID of the report schedule author.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for report schedules. \nAllowed enum values: schedule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related resources included with the report schedule, such as the author.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A user included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the report author.

\n
\n
\n
\n
\n
\n

email [required]

\n
\n

string

\n

The email address of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data object representing a report schedule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The configuration and derived state of a report schedule.

\n
\n
\n
\n
\n
\n

delivery_format

\n
\n

enum

\n

The delivery format for dashboard report schedules, or null if not set. \nAllowed enum values: pdf,png,pdf_and_png

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the report.

\n
\n \n
\n
\n
\n
\n
\n

next_recurrence [required]

\n
\n

int64

\n

The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).

\n
\n \n
\n
\n
\n
\n
\n

resource_id [required]

\n
\n

string

\n

The identifier of the resource rendered in the report.

\n
\n \n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Whether the schedule is currently delivering reports (active) or paused (inactive). \nAllowed enum values: active,inactive

\n
\n \n
\n
\n
\n
\n
\n

tab_id [required]

\n
\n

string

\n

The identifier of the dashboard tab rendered in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

template_variables [required]

\n
\n

[object]

\n

The dashboard template variables applied when rendering the report.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template variable.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The selected values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeframe [required]

\n
\n

string

\n

The relative timeframe of data included in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

The IANA time zone identifier the recurrence rule is evaluated in.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the report.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the report schedule.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for the report schedule.

\n
\n
\n
\n
\n
\n

author [required]

\n
\n

object

\n

Relationship to the author of the report schedule.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship data for the author of the report schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID of the report schedule author.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for report schedules. \nAllowed enum values: schedule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related resources included with the report schedule, such as the author.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A user included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the report author.

\n
\n
\n
\n
\n
\n

email [required]

\n
\n

string

\n

The email address of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A report target resource included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an included report target resource.

\n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

Template variable metadata from the dashboard resource, when available.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

Available values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

Default values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The template variable name.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix for the template variable, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the dashboard or integration dashboard resource, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The resource identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for an included report resource. \nAllowed enum values: resource

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -138,7 +138,7 @@ ] } ], - "timeframe": "calendar_month", + "timeframe": "1w", "timezone": "America/New_York", "title": "Weekly Infrastructure Report" }, @@ -167,7 +167,7 @@ ] } ], - "timeframe": "calendar_month", + "timeframe": "1w", "timezone": "America/New_York", "title": "Weekly Infrastructure Report" }, @@ -177,6 +177,560 @@ "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data object for a report schedule creation request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The configuration of the report schedule to create.

\n
\n
\n
\n
\n
\n

delivery_format

\n
\n

enum

\n

How a PDF-export report is delivered. pdf attaches a PDF file, png embeds\nan inline PNG image, and pdf_and_png delivers both. \nAllowed enum values: pdf,png,pdf_and_png

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

A description of the report, up to 4096 characters.

\n
\n \n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

The recipients of the report. Each entry is an email address, a Slack channel\nreference in the form slack:{team_id}.{channel_id}.{channel_name}, or a Microsoft\nTeams channel reference in the form teams:{tenant_id}|{team_id}|{channel_id}.

\n
\n \n
\n
\n
\n
\n
\n

resource_id [required]

\n
\n

string

\n

The identifier of the dashboard or integration dashboard to render in the report.

\n
\n \n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

tab_id

\n
\n

uuid

\n

The identifier of the dashboard tab to render, when the dashboard has tabs.

\n
\n \n
\n
\n
\n
\n
\n

template_variables [required]

\n
\n

[object]

\n

The dashboard template variables applied when rendering the report.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template variable.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The selected values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeframe [required]

\n
\n

string

\n

The relative timeframe of data to include in the report.

\n
\n \n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

The IANA time zone identifier the recurrence rule is evaluated in.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the report, between 1 and 78 characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for report schedules. \nAllowed enum values: schedule

\n
\n \n
\n
\n
\n
" } }, + "ListReportSchedules": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "delivery_format": "pdf", + "description": "Weekly summary of infrastructure health.", + "next_recurrence": 1780923600000, + "query_params": { + "": "undefined" + }, + "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": { + "first_offset": 0, + "last_offset": 0, + "limit": 25, + "next_offset": 25, + "offset": 0, + "prev_offset": 0, + "total": 1, + "type": "offset_limit" + } + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The list of report schedules.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The configuration and derived state of a report schedule in a list response.

\n
\n
\n
\n
\n
\n

delivery_format

\n
\n

enum

\n

The delivery format for dashboard report schedules, or null if not set. \nAllowed enum values: pdf,png,pdf_and_png

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the report.

\n
\n \n
\n
\n
\n
\n
\n

next_recurrence [required]

\n
\n

int64

\n

The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

query_params [required]

\n
\n

object

\n

Query parameters applied when rendering the report.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

A query parameter value applied when rendering the report, either a single string or a list of strings.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

A single query parameter value.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

A list of query parameter values.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).

\n
\n \n
\n
\n
\n
\n
\n

resource_id [required]

\n
\n

string

\n

The identifier of the resource rendered in the report.

\n
\n \n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Whether the schedule is currently delivering reports (active) or paused (inactive). \nAllowed enum values: active,inactive

\n
\n \n
\n
\n
\n
\n
\n

template_variables [required]

\n
\n

[object]

\n

The dashboard template variables applied when rendering the report.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template variable.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The selected values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeframe [required]

\n
\n

string

\n

The relative timeframe of data included in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

The IANA time zone identifier the recurrence rule is evaluated in.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the report.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the report schedule.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for a report schedule in a list response.

\n
\n
\n
\n
\n
\n

author [required]

\n
\n

object

\n

Relationship to the author of the report schedule.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship data for the author of the report schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID of the report schedule author.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

resource

\n
\n

object

\n

Relationship to the report target resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship data for the report target resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The resource identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for an included report resource. \nAllowed enum values: resource

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for report schedules. \nAllowed enum values: schedule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related resources included with the report schedules, such as authors and rendered resources.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A user included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the report author.

\n
\n
\n
\n
\n
\n

email [required]

\n
\n

string

\n

The email address of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A report target resource included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an included report target resource.

\n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

Template variable metadata from the dashboard resource, when available.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

Available values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

Default values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The template variable name.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix for the template variable, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the dashboard or integration dashboard resource, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The resource identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for an included report resource. \nAllowed enum values: resource

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Pagination links for navigating a report schedule list response.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

Link to the first page.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Link to the last page, or null if it is unavailable.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page, or null if it is unavailable.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to the previous page, or null if it is unavailable.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Link to the current page.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Metadata for a paginated report schedule list response.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Offset and limit pagination metadata for a report schedule list response.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset when the total count is known, or null if it is unavailable.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

The maximum number of schedules returned.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The current offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

The total number of matching schedules.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The pagination type. \nAllowed enum values: offset_limit

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetReportSchedulesForResource": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "delivery_format": "pdf", + "description": "Weekly summary of infrastructure health.", + "next_recurrence": 1780923600000, + "query_params": { + "": "undefined" + }, + "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": { + "first_offset": 0, + "last_offset": 0, + "limit": 25, + "next_offset": 25, + "offset": 0, + "prev_offset": 0, + "total": 1, + "type": "offset_limit" + } + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The list of report schedules.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The configuration and derived state of a report schedule in a list response.

\n
\n
\n
\n
\n
\n

delivery_format

\n
\n

enum

\n

The delivery format for dashboard report schedules, or null if not set. \nAllowed enum values: pdf,png,pdf_and_png

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the report.

\n
\n \n
\n
\n
\n
\n
\n

next_recurrence [required]

\n
\n

int64

\n

The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

query_params [required]

\n
\n

object

\n

Query parameters applied when rendering the report.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

A query parameter value applied when rendering the report, either a single string or a list of strings.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

A single query parameter value.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

A list of query parameter values.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).

\n
\n \n
\n
\n
\n
\n
\n

resource_id [required]

\n
\n

string

\n

The identifier of the resource rendered in the report.

\n
\n \n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Whether the schedule is currently delivering reports (active) or paused (inactive). \nAllowed enum values: active,inactive

\n
\n \n
\n
\n
\n
\n
\n

template_variables [required]

\n
\n

[object]

\n

The dashboard template variables applied when rendering the report.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template variable.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The selected values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeframe [required]

\n
\n

string

\n

The relative timeframe of data included in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

The IANA time zone identifier the recurrence rule is evaluated in.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the report.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the report schedule.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for a report schedule in a list response.

\n
\n
\n
\n
\n
\n

author [required]

\n
\n

object

\n

Relationship to the author of the report schedule.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship data for the author of the report schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID of the report schedule author.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

resource

\n
\n

object

\n

Relationship to the report target resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship data for the report target resource.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The resource identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for an included report resource. \nAllowed enum values: resource

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for report schedules. \nAllowed enum values: schedule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related resources included with the report schedules, such as authors and rendered resources.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A user included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the report author.

\n
\n
\n
\n
\n
\n

email [required]

\n
\n

string

\n

The email address of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A report target resource included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an included report target resource.

\n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

Template variable metadata from the dashboard resource, when available.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

Available values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

Default values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The template variable name.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix for the template variable, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the dashboard or integration dashboard resource, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The resource identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for an included report resource. \nAllowed enum values: resource

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Pagination links for navigating a report schedule list response.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

Link to the first page.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Link to the last page, or null if it is unavailable.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page, or null if it is unavailable.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to the previous page, or null if it is unavailable.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Link to the current page.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Metadata for a paginated report schedule list response.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Offset and limit pagination metadata for a report schedule list response.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset when the total count is known, or null if it is unavailable.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

The maximum number of schedules returned.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The current offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

The total number of matching schedules.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The pagination type. \nAllowed enum values: offset_limit

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "DeleteReportSchedule": { + "responses": { + "200": { + "json": { + "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", + "tab_id": "66666666-7777-8888-9999-000000000000", + "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" + } + } + }, + "type": "schedule" + }, + "included": [ + { + "attributes": { + "email": "user@example.com", + "name": "Example User" + }, + "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data object representing a report schedule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The configuration and derived state of a report schedule.

\n
\n
\n
\n
\n
\n

delivery_format

\n
\n

enum

\n

The delivery format for dashboard report schedules, or null if not set. \nAllowed enum values: pdf,png,pdf_and_png

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the report.

\n
\n \n
\n
\n
\n
\n
\n

next_recurrence [required]

\n
\n

int64

\n

The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).

\n
\n \n
\n
\n
\n
\n
\n

resource_id [required]

\n
\n

string

\n

The identifier of the resource rendered in the report.

\n
\n \n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Whether the schedule is currently delivering reports (active) or paused (inactive). \nAllowed enum values: active,inactive

\n
\n \n
\n
\n
\n
\n
\n

tab_id [required]

\n
\n

string

\n

The identifier of the dashboard tab rendered in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

template_variables [required]

\n
\n

[object]

\n

The dashboard template variables applied when rendering the report.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template variable.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The selected values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeframe [required]

\n
\n

string

\n

The relative timeframe of data included in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

The IANA time zone identifier the recurrence rule is evaluated in.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the report.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the report schedule.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for the report schedule.

\n
\n
\n
\n
\n
\n

author [required]

\n
\n

object

\n

Relationship to the author of the report schedule.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship data for the author of the report schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID of the report schedule author.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for report schedules. \nAllowed enum values: schedule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related resources included with the report schedule, such as the author.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A user included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the report author.

\n
\n
\n
\n
\n
\n

email [required]

\n
\n

string

\n

The email address of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A report target resource included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an included report target resource.

\n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

Template variable metadata from the dashboard resource, when available.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

Available values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

Default values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The template variable name.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix for the template variable, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the dashboard or integration dashboard resource, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The resource identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for an included report resource. \nAllowed enum values: resource

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetReportSchedule": { + "responses": { + "200": { + "json": { + "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", + "tab_id": "66666666-7777-8888-9999-000000000000", + "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" + } + } + }, + "type": "schedule" + }, + "included": [ + { + "attributes": { + "email": "user@example.com", + "name": "Example User" + }, + "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data object representing a report schedule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The configuration and derived state of a report schedule.

\n
\n
\n
\n
\n
\n

delivery_format

\n
\n

enum

\n

The delivery format for dashboard report schedules, or null if not set. \nAllowed enum values: pdf,png,pdf_and_png

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the report.

\n
\n \n
\n
\n
\n
\n
\n

next_recurrence [required]

\n
\n

int64

\n

The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).

\n
\n \n
\n
\n
\n
\n
\n

resource_id [required]

\n
\n

string

\n

The identifier of the resource rendered in the report.

\n
\n \n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Whether the schedule is currently delivering reports (active) or paused (inactive). \nAllowed enum values: active,inactive

\n
\n \n
\n
\n
\n
\n
\n

tab_id [required]

\n
\n

string

\n

The identifier of the dashboard tab rendered in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

template_variables [required]

\n
\n

[object]

\n

The dashboard template variables applied when rendering the report.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template variable.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The selected values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeframe [required]

\n
\n

string

\n

The relative timeframe of data included in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

The IANA time zone identifier the recurrence rule is evaluated in.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the report.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the report schedule.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for the report schedule.

\n
\n
\n
\n
\n
\n

author [required]

\n
\n

object

\n

Relationship to the author of the report schedule.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship data for the author of the report schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID of the report schedule author.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for report schedules. \nAllowed enum values: schedule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related resources included with the report schedule, such as the author.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A user included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the report author.

\n
\n
\n
\n
\n
\n

email [required]

\n
\n

string

\n

The email address of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A report target resource included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an included report target resource.

\n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

Template variable metadata from the dashboard resource, when available.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

Available values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

Default values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The template variable name.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix for the template variable, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the dashboard or integration dashboard resource, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The resource identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for an included report resource. \nAllowed enum values: resource

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, "PatchReportSchedule": { "responses": { "200": { @@ -193,7 +747,7 @@ ], "resource_id": "abc-def-ghi", "resource_type": "dashboard", - "rrule": "FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0", + "rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0", "status": "active", "tab_id": "66666666-7777-8888-9999-000000000000", "template_variables": [ @@ -230,7 +784,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data object representing a report schedule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The configuration and derived state of a report schedule.

\n
\n
\n
\n
\n
\n

delivery_format

\n
\n

enum

\n

The delivery format for dashboard report schedules, or null if not set. \nAllowed enum values: pdf,png,pdf_and_png

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the report.

\n
\n \n
\n
\n
\n
\n
\n

next_recurrence [required]

\n
\n

int64

\n

The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).

\n
\n \n
\n
\n
\n
\n
\n

resource_id [required]

\n
\n

string

\n

The identifier of the resource rendered in the report.

\n
\n \n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Whether the schedule is currently delivering reports (active) or paused (inactive). \nAllowed enum values: active,inactive

\n
\n \n
\n
\n
\n
\n
\n

tab_id [required]

\n
\n

string

\n

The identifier of the dashboard tab rendered in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

template_variables [required]

\n
\n

[object]

\n

The dashboard template variables applied when rendering the report.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template variable.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The selected values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeframe [required]

\n
\n

string

\n

The relative timeframe of data included in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

The IANA time zone identifier the recurrence rule is evaluated in.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the report.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the report schedule.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for the report schedule.

\n
\n
\n
\n
\n
\n

author [required]

\n
\n

object

\n

Relationship to the author of the report schedule.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship data for the author of the report schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID of the report schedule author.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for report schedules. \nAllowed enum values: schedule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related resources included with the report schedule, such as the author.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A user included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the report author.

\n
\n
\n
\n
\n
\n

email [required]

\n
\n

string

\n

The email address of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data object representing a report schedule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The configuration and derived state of a report schedule.

\n
\n
\n
\n
\n
\n

delivery_format

\n
\n

enum

\n

The delivery format for dashboard report schedules, or null if not set. \nAllowed enum values: pdf,png,pdf_and_png

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the report.

\n
\n \n
\n
\n
\n
\n
\n

next_recurrence [required]

\n
\n

int64

\n

The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).

\n
\n \n
\n
\n
\n
\n
\n

resource_id [required]

\n
\n

string

\n

The identifier of the resource rendered in the report.

\n
\n \n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Whether the schedule is currently delivering reports (active) or paused (inactive). \nAllowed enum values: active,inactive

\n
\n \n
\n
\n
\n
\n
\n

tab_id [required]

\n
\n

string

\n

The identifier of the dashboard tab rendered in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

template_variables [required]

\n
\n

[object]

\n

The dashboard template variables applied when rendering the report.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template variable.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The selected values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeframe [required]

\n
\n

string

\n

The relative timeframe of data included in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

The IANA time zone identifier the recurrence rule is evaluated in.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the report.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the report schedule.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for the report schedule.

\n
\n
\n
\n
\n
\n

author [required]

\n
\n

object

\n

Relationship to the author of the report schedule.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship data for the author of the report schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID of the report schedule author.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for report schedules. \nAllowed enum values: schedule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related resources included with the report schedule, such as the author.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A user included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the report author.

\n
\n
\n
\n
\n
\n

email [required]

\n
\n

string

\n

The email address of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A report target resource included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an included report target resource.

\n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

Template variable metadata from the dashboard resource, when available.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

Available values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

Default values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The template variable name.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix for the template variable, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the dashboard or integration dashboard resource, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The resource identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for an included report resource. \nAllowed enum values: resource

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -314,7 +868,7 @@ ] } ], - "timeframe": "calendar_month", + "timeframe": "1w", "timezone": "America/New_York", "title": "Weekly Infrastructure Report" }, @@ -341,7 +895,7 @@ ] } ], - "timeframe": "calendar_month", + "timeframe": "1w", "timezone": "America/New_York", "title": "Weekly Infrastructure Report" }, @@ -350,5 +904,143 @@ }, "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data object for a report schedule update request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The updated configuration of the report schedule. These values replace the existing\nones; the targeted resource (resource_id and resource_type) cannot be changed.

\n
\n
\n
\n
\n
\n

delivery_format

\n
\n

enum

\n

How a PDF-export report is delivered. pdf attaches a PDF file, png embeds\nan inline PNG image, and pdf_and_png delivers both. \nAllowed enum values: pdf,png,pdf_and_png

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

A description of the report, up to 4096 characters.

\n
\n \n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

The recipients of the report. Each entry is an email address, a Slack channel\nreference in the form slack:{team_id}.{channel_id}.{channel_name}, or a Microsoft\nTeams channel reference in the form teams:{tenant_id}|{team_id}|{channel_id}.

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

tab_id

\n
\n

uuid

\n

The identifier of the dashboard tab to render, when the dashboard has tabs.

\n
\n \n
\n
\n
\n
\n
\n

template_variables [required]

\n
\n

[object]

\n

The dashboard template variables applied when rendering the report.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template variable.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The selected values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeframe [required]

\n
\n

string

\n

The relative timeframe of data to include in the report.

\n
\n \n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

The IANA time zone identifier the recurrence rule is evaluated in.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the report, between 1 and 78 characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for report schedules. \nAllowed enum values: schedule

\n
\n \n
\n
\n
\n
" } + }, + "ToggleReportSchedule": { + "responses": { + "200": { + "json": { + "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", + "tab_id": "66666666-7777-8888-9999-000000000000", + "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" + } + } + }, + "type": "schedule" + }, + "included": [ + { + "attributes": { + "email": "user@example.com", + "name": "Example User" + }, + "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data object representing a report schedule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The configuration and derived state of a report schedule.

\n
\n
\n
\n
\n
\n

delivery_format

\n
\n

enum

\n

The delivery format for dashboard report schedules, or null if not set. \nAllowed enum values: pdf,png,pdf_and_png

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the report.

\n
\n \n
\n
\n
\n
\n
\n

next_recurrence [required]

\n
\n

int64

\n

The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).

\n
\n \n
\n
\n
\n
\n
\n

resource_id [required]

\n
\n

string

\n

The identifier of the resource rendered in the report.

\n
\n \n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Whether the schedule is currently delivering reports (active) or paused (inactive). \nAllowed enum values: active,inactive

\n
\n \n
\n
\n
\n
\n
\n

tab_id [required]

\n
\n

string

\n

The identifier of the dashboard tab rendered in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

template_variables [required]

\n
\n

[object]

\n

The dashboard template variables applied when rendering the report.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template variable.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The selected values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeframe [required]

\n
\n

string

\n

The relative timeframe of data included in the report, or null if not set.

\n
\n \n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

The IANA time zone identifier the recurrence rule is evaluated in.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the report.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the report schedule.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for the report schedule.

\n
\n
\n
\n
\n
\n

author [required]

\n
\n

object

\n

Relationship to the author of the report schedule.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship data for the author of the report schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID of the report schedule author.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for report schedules. \nAllowed enum values: schedule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related resources included with the report schedule, such as the author.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A user included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the report author.

\n
\n
\n
\n
\n
\n

email [required]

\n
\n

string

\n

The email address of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the report author, or null if unavailable.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user UUID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for the included report author. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A report target resource included as a related JSON:API resource.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an included report target resource.

\n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

enum

\n

The type of dashboard resource the report schedule targets. \nAllowed enum values: dashboard,integration_dashboard

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

Template variable metadata from the dashboard resource, when available.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

Available values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

Default values for the template variable.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The template variable name.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix for the template variable, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the dashboard or integration dashboard resource, when available.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The resource identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for an included report resource. \nAllowed enum values: resource

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "status": "active" + }, + "type": "schedule" + } + }, + "json": { + "data": { + "attributes": { + "status": "active" + }, + "type": "schedule" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data object for a report schedule toggle request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The status to set on the report schedule.

\n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

Whether the schedule is currently delivering reports (active) or paused (inactive). \nAllowed enum values: active,inactive

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for report schedules. \nAllowed enum values: schedule

\n
\n \n
\n
\n
\n
" + } } } \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 146c9e69b84..a57842e9b1f 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -28523,6 +28523,31 @@ components: - bucket_name - bucket_region type: object + DataObservabilityMonitorRunStatus: + description: The status of a data observability monitor run. + enum: + - pending + - ok + - warn + - alert + - error + example: pending + type: string + x-enum-varnames: + - PENDING + - OK + - WARN + - ALERT + - ERROR + DataObservabilityMonitorRunType: + default: monitor_run + description: The JSON:API resource type for a data observability monitor run. + enum: + - monitor_run + example: monitor_run + type: string + x-enum-varnames: + - MONITOR_RUN DataRelationshipsTeams: description: Associates teams with this schedule in a data structure. properties: @@ -39197,6 +39222,42 @@ components: required: - data type: object + GetDataObservabilityMonitorRunStatusResponse: + description: The response for getting the status of a data observability monitor run. + properties: + data: + $ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponseData" + required: + - data + type: object + GetDataObservabilityMonitorRunStatusResponseAttributes: + description: The attributes of a data observability monitor run status response. + properties: + error_message: + description: Error message describing why the monitor run failed. Only present when status is error. + example: "run completed but produced no metric data" + type: string + status: + $ref: "#/components/schemas/DataObservabilityMonitorRunStatus" + required: + - status + type: object + GetDataObservabilityMonitorRunStatusResponseData: + description: The data object for a data observability monitor run status response. + properties: + attributes: + $ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponseAttributes" + id: + description: The unique identifier of the monitor run. + example: "abc123def456" + type: string + type: + $ref: "#/components/schemas/DataObservabilityMonitorRunType" + required: + - id + - type + - attributes + type: object GetDeviceAttributes: description: The device attributes properties: @@ -75351,7 +75412,7 @@ components: type: array timeframe: description: The relative timeframe of data to include in the report. - example: "calendar_month" + example: "1w" type: string timezone: description: The IANA time zone identifier the recurrence rule is evaluated in. @@ -75403,6 +75464,276 @@ components: description: A related resource included with a report schedule. oneOf: - $ref: "#/components/schemas/ReportScheduleAuthor" + - $ref: "#/components/schemas/ReportScheduleResource" + ReportScheduleIncludedResourceType: + description: JSON:API resource type for an included report resource. + enum: + - resource + example: resource + type: string + x-enum-varnames: + - RESOURCE + ReportScheduleIndexTemplateVariable: + description: Template variable metadata from a dashboard index. + properties: + available_values: + description: Available values for the template variable. + example: + - prod + - staging + items: + type: string + nullable: true + type: array + defaults: + description: Default values for the template variable. + example: + - prod + items: + type: string + nullable: true + type: array + name: + description: The template variable name. + example: env + nullable: true + type: string + prefix: + description: The tag prefix for the template variable, when available. + example: env + nullable: true + type: string + type: object + ReportScheduleListResourceRelationship: + description: Relationship to the report target resource. + properties: + data: + $ref: "#/components/schemas/ReportScheduleListResourceRelationshipData" + required: + - data + type: object + ReportScheduleListResourceRelationshipData: + description: Relationship data for the report target resource. + properties: + id: + description: The resource identifier. + example: "abc-def-ghi" + type: string + type: + $ref: "#/components/schemas/ReportScheduleIncludedResourceType" + required: + - id + - type + type: object + ReportScheduleListResponse: + description: Response containing a list of report schedules. + properties: + data: + description: The list of report schedules. + items: + $ref: "#/components/schemas/ReportScheduleListResponseData" + type: array + included: + description: Related resources included with the report schedules, such as authors and rendered resources. + items: + $ref: "#/components/schemas/ReportScheduleIncludedResource" + type: array + links: + $ref: "#/components/schemas/ReportScheduleListResponseLinks" + meta: + $ref: "#/components/schemas/ReportScheduleListResponseMeta" + required: + - data + type: object + ReportScheduleListResponseAttributes: + description: The configuration and derived state of a report schedule in a list response. + properties: + delivery_format: + $ref: "#/components/schemas/ReportScheduleResponseAttributesDeliveryFormat" + description: + description: The description of the report. + example: "Weekly summary of infrastructure health." + type: string + next_recurrence: + description: The Unix timestamp, in milliseconds, of the next scheduled delivery, or `null` if none is scheduled. + example: 1780923600000 + format: int64 + nullable: true + type: integer + query_params: + additionalProperties: + $ref: "#/components/schemas/ReportScheduleQueryParameterValue" + description: Query parameters applied when rendering the report. + example: {} + type: object + recipients: + description: The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references). + example: + - "user@example.com" + - "slack:T01234567.C01234567.alerts" + - "teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2" + items: + description: A single recipient (email address, Slack channel reference, or Microsoft Teams channel reference). + type: string + type: array + resource_id: + description: The identifier of the resource rendered in the report. + example: "abc-def-ghi" + type: string + resource_type: + $ref: "#/components/schemas/ReportScheduleResourceType" + rrule: + description: The recurrence rule for the schedule, expressed as an iCalendar `RRULE` string. + example: "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0" + type: string + status: + $ref: "#/components/schemas/ReportScheduleStatus" + template_variables: + description: The dashboard template variables applied when rendering the report. + items: + $ref: "#/components/schemas/ReportScheduleTemplateVariable" + type: array + timeframe: + description: The relative timeframe of data included in the report, or `null` if not set. + example: "1w" + nullable: true + type: string + timezone: + description: The IANA time zone identifier the recurrence rule is evaluated in. + example: "America/New_York" + type: string + title: + description: The title of the report. + example: "Weekly Infrastructure Report" + type: string + required: + - status + - resource_id + - resource_type + - recipients + - rrule + - timezone + - template_variables + - title + - description + - timeframe + - query_params + - next_recurrence + type: object + ReportScheduleListResponseData: + description: The JSON:API data object representing a report schedule in a list response. + properties: + attributes: + $ref: "#/components/schemas/ReportScheduleListResponseAttributes" + id: + description: The unique identifier of the report schedule. + example: "11111111-2222-3333-4444-555555555555" + type: string + relationships: + $ref: "#/components/schemas/ReportScheduleListResponseRelationships" + type: + $ref: "#/components/schemas/ReportScheduleType" + required: + - id + - type + - attributes + - relationships + type: object + ReportScheduleListResponseLinks: + description: Pagination links for navigating a report schedule list response. + properties: + first: + description: Link to the first page. + example: "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=0&page[limit]=25" + nullable: true + type: string + last: + description: Link to the last page, or `null` if it is unavailable. + example: "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=0&page[limit]=25" + nullable: true + type: string + next: + description: Link to the next page, or `null` if it is unavailable. + example: "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=25&page[limit]=25" + nullable: true + type: string + prev: + description: Link to the previous page, or `null` if it is unavailable. + example: "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=0&page[limit]=25" + nullable: true + type: string + self: + description: Link to the current page. + example: "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[limit]=25" + nullable: true + type: string + type: object + ReportScheduleListResponseMeta: + description: Metadata for a paginated report schedule list response. + properties: + pagination: + $ref: "#/components/schemas/ReportScheduleListResponsePagination" + type: object + ReportScheduleListResponsePagination: + description: Offset and limit pagination metadata for a report schedule list response. + properties: + first_offset: + description: The first offset. + example: 0 + format: int64 + type: integer + last_offset: + description: The last offset when the total count is known, or `null` if it is unavailable. + example: 0 + format: int64 + nullable: true + type: integer + limit: + description: The maximum number of schedules returned. + example: 25 + format: int64 + type: integer + next_offset: + description: The next offset. + example: 25 + format: int64 + type: integer + offset: + description: The current offset. + example: 0 + format: int64 + type: integer + prev_offset: + description: The previous offset. + example: 0 + format: int64 + type: integer + total: + description: The total number of matching schedules. + example: 1 + format: int64 + type: integer + type: + $ref: "#/components/schemas/ReportScheduleListResponsePaginationType" + type: object + ReportScheduleListResponsePaginationType: + description: The pagination type. + enum: + - offset_limit + example: offset_limit + type: string + x-enum-varnames: + - OFFSET_LIMIT + ReportScheduleListResponseRelationships: + description: Relationships for a report schedule in a list response. + properties: + author: + $ref: "#/components/schemas/ReportScheduleAuthorRelationship" + resource: + $ref: "#/components/schemas/ReportScheduleListResourceRelationship" + required: + - author + type: object ReportSchedulePatchRequest: description: Request body for updating a report schedule. properties: @@ -75452,7 +75783,7 @@ components: type: array timeframe: description: The relative timeframe of data to include in the report. - example: "calendar_month" + example: "1w" type: string timezone: description: The IANA time zone identifier the recurrence rule is evaluated in. @@ -75484,6 +75815,58 @@ components: - type - attributes type: object + ReportScheduleQueryParameterValue: + description: A query parameter value applied when rendering the report, either a single string or a list of strings. + oneOf: + - $ref: "#/components/schemas/ReportScheduleQueryParameterValueString" + - $ref: "#/components/schemas/ReportScheduleQueryParameterValueStringArray" + ReportScheduleQueryParameterValueString: + description: A single query parameter value. + example: "prod" + type: string + ReportScheduleQueryParameterValueStringArray: + description: A list of query parameter values. + example: + - "prod" + items: + description: A single query parameter value. + type: string + type: array + ReportScheduleResource: + description: A report target resource included as a related JSON:API resource. + properties: + attributes: + $ref: "#/components/schemas/ReportScheduleResourceAttributes" + id: + description: The resource identifier. + example: "abc-def-ghi" + type: string + type: + $ref: "#/components/schemas/ReportScheduleIncludedResourceType" + required: + - type + - id + - attributes + type: object + ReportScheduleResourceAttributes: + description: Attributes of an included report target resource. + properties: + resource_type: + $ref: "#/components/schemas/ReportScheduleResourceType" + template_variables: + description: Template variable metadata from the dashboard resource, when available. + items: + $ref: "#/components/schemas/ReportScheduleIndexTemplateVariable" + nullable: true + type: array + title: + description: The title of the dashboard or integration dashboard resource, when available. + example: "Infrastructure Overview" + nullable: true + type: string + required: + - resource_type + type: object ReportScheduleResourceType: description: The type of dashboard resource the report schedule targets. enum: @@ -75540,7 +75923,7 @@ components: $ref: "#/components/schemas/ReportScheduleResourceType" rrule: description: The recurrence rule for the schedule, expressed as an iCalendar `RRULE` string. - example: "FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0" + example: "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0" type: string status: $ref: "#/components/schemas/ReportScheduleStatus" @@ -75650,6 +76033,33 @@ components: - name - values type: object + ReportScheduleToggleRequest: + description: Request body for toggling a report schedule. + properties: + data: + $ref: "#/components/schemas/ReportScheduleToggleRequestData" + required: + - data + type: object + ReportScheduleToggleRequestAttributes: + description: The status to set on the report schedule. + properties: + status: + $ref: "#/components/schemas/ReportScheduleStatus" + required: + - status + type: object + ReportScheduleToggleRequestData: + description: The JSON:API data object for a report schedule toggle request. + properties: + attributes: + $ref: "#/components/schemas/ReportScheduleToggleRequestAttributes" + type: + $ref: "#/components/schemas/ReportScheduleType" + required: + - type + - attributes + type: object ReportScheduleType: description: JSON:API resource type for report schedules. enum: @@ -78882,6 +79292,27 @@ components: $ref: "#/components/schemas/RumRetentionFilterData" type: array type: object + RunDataObservabilityMonitorResponse: + description: The response returned when a data observability monitor run is triggered. + properties: + data: + $ref: "#/components/schemas/RunDataObservabilityMonitorResponseData" + required: + - data + type: object + RunDataObservabilityMonitorResponseData: + description: The data object returned when a data observability monitor run is triggered. + properties: + id: + description: The unique identifier of the monitor run. + example: "abc123def456" + type: string + type: + $ref: "#/components/schemas/DataObservabilityMonitorRunType" + required: + - id + - type + type: object RunHistoricalJobRequest: description: Run a historical job request. properties: @@ -126182,6 +126613,107 @@ paths: x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/data-observability/monitors/runs/{run_id}/status: + get: + description: Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete. + operationId: GetDataObservabilityMonitorRunStatus + parameters: + - description: The ID of the monitor run to retrieve status for. + example: "abc123def456" + in: path + name: run_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + status: ok + id: "abc123def456" + type: monitor_run + schema: + $ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponse" + description: OK + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - data_observability_monitors_write + - monitors_write + summary: Get data observability monitor run status + tags: + - Data Observability + x-menu-order: 2 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/data-observability/monitors/{monitor_id}/run: + post: + description: Manually triggers a run for a data observability monitor. Only monitors that are not scheduled (manually-runnable) can be triggered this way. + operationId: RunDataObservabilityMonitor + parameters: + - description: The ID of the data observability monitor to run. + example: 12345 + in: path + name: monitor_id + required: true + schema: + format: int64 + type: integer + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + id: "abc123def456" + type: monitor_run + schema: + $ref: "#/components/schemas/RunDataObservabilityMonitorResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - data_observability_monitors_write + - monitors_write + summary: Run a data observability monitor + tags: + - Data Observability + x-menu-order: 1 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/datasets: get: description: Get all datasets that have been configured for an organization. @@ -160376,7 +160908,389 @@ paths: x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/reporting/schedule/list: + get: + description: |- + 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. + operationId: ListReportSchedules + parameters: + - description: The maximum number of schedules to return. The maximum value is 50. + example: 25 + in: query + name: page[limit] + required: false + schema: + default: 25 + format: int64 + maximum: 50 + minimum: 1 + type: integer + - description: The offset from which to start returning schedules. + example: 0 + in: query + name: page[offset] + required: false + schema: + default: 0 + format: int64 + minimum: 0 + type: integer + - description: Filter schedules by report title. + example: "Weekly" + in: query + name: filter[title] + required: false + schema: + type: string + - description: Filter schedules by author UUID. + example: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" + in: query + name: filter[author_uuid] + required: false + schema: + format: uuid + type: string + - description: Filter schedules by a comma-separated list of recipients. + example: "user@example.com,team@example.com" + in: query + name: filter[recipients] + required: false + schema: + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + delivery_format: pdf + description: "Weekly summary of infrastructure health." + next_recurrence: 1780923600000 + query_params: {} + recipients: + - "user@example.com" + 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 + - attributes: + resource_type: dashboard + template_variables: + - available_values: + - "prod" + - "staging" + defaults: + - "prod" + name: "env" + prefix: "env" + title: "Infrastructure Overview" + id: "abc-def-ghi" + type: resource + links: + first: "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=0&page[limit]=25" + last: + next: "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[offset]=25&page[limit]=25" + prev: + self: "https://api.datadoghq.com/api/v2/reporting/schedule/list?page[limit]=25" + meta: + pagination: + first_offset: 0 + last_offset: 0 + limit: 25 + next_offset: 25 + offset: 0 + prev_offset: 0 + total: 1 + type: offset_limit + schema: + $ref: "#/components/schemas/ReportScheduleListResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: List report schedules + tags: + - Report Schedules + x-menu-order: 6 + /api/v2/reporting/schedule/{resource_type}/{resource_id}: + get: + description: |- + Get all report schedules that target a dashboard or integration dashboard resource. + Requires a reporting read permission appropriate to the targeted resource type. + operationId: GetReportSchedulesForResource + parameters: + - description: The type of resource to fetch report schedules for. + example: dashboard + in: path + name: resource_type + required: true + schema: + $ref: "#/components/schemas/ReportScheduleResourceType" + - description: The identifier of the resource to fetch report schedules for. + example: "abc-def-ghi" + in: path + name: resource_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + delivery_format: pdf + description: "Weekly summary of infrastructure health." + next_recurrence: 1780923600000 + recipients: + - "user@example.com" + 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 + tab_id: + template_variables: + - name: "env" + values: + - "prod" + timeframe: "1w" + timezone: "America/New_York" + title: "Weekly Infrastructure Report" + id: "11111111-2222-3333-4444-555555555555" + type: schedule + included: + - attributes: + email: "user@example.com" + name: "Example User" + id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" + type: users + schema: + $ref: "#/components/schemas/ReportScheduleListResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Get report schedules for a resource + tags: + - Report Schedules + x-menu-order: 5 /api/v2/reporting/schedule/{schedule_uuid}: + delete: + description: |- + 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. + operationId: DeleteReportSchedule + parameters: + - description: The unique identifier of the report schedule to delete. + example: "11111111-2222-3333-4444-555555555555" + in: path + name: schedule_uuid + required: true + schema: + format: uuid + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + delivery_format: pdf + description: "Weekly summary of infrastructure health." + next_recurrence: + recipients: + - "user@example.com" + 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: inactive + tab_id: + template_variables: + - name: "env" + values: + - "prod" + timeframe: "1w" + timezone: "America/New_York" + title: "Weekly Infrastructure Report" + id: "11111111-2222-3333-4444-555555555555" + type: schedule + included: + - attributes: + email: "user@example.com" + name: "Example User" + id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" + type: users + schema: + $ref: "#/components/schemas/ReportScheduleResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Delete a report schedule + tags: + - Report Schedules + x-menu-order: 7 + get: + description: |- + Get a report schedule by its unique identifier. + Requires a reporting read permission appropriate to the targeted resource type. + operationId: GetReportSchedule + parameters: + - description: The unique identifier of the report schedule to fetch. + example: "11111111-2222-3333-4444-555555555555" + in: path + name: schedule_uuid + required: true + schema: + format: uuid + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + delivery_format: pdf + description: "Weekly summary of infrastructure health." + next_recurrence: 1780923600000 + recipients: + - "user@example.com" + 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 + tab_id: + template_variables: + - name: "env" + values: + - "prod" + timeframe: "1w" + timezone: "America/New_York" + title: "Weekly Infrastructure Report" + id: "11111111-2222-3333-4444-555555555555" + type: schedule + included: + - attributes: + email: "user@example.com" + name: "Example User" + id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" + type: users + schema: + $ref: "#/components/schemas/ReportScheduleResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Get a report schedule + tags: + - Report Schedules + x-menu-order: 3 patch: description: |- Update an existing scheduled report by its identifier. The editable attributes @@ -160491,6 +161405,96 @@ paths: x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/reporting/schedule/{schedule_uuid}/toggle: + patch: + description: |- + 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. + operationId: ToggleReportSchedule + parameters: + - description: The unique identifier of the report schedule to toggle. + example: "11111111-2222-3333-4444-555555555555" + in: path + name: schedule_uuid + required: true + schema: + format: uuid + type: string + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + status: inactive + type: schedule + schema: + $ref: "#/components/schemas/ReportScheduleToggleRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + delivery_format: pdf + description: "Weekly summary of infrastructure health." + next_recurrence: + recipients: + - "user@example.com" + 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: inactive + tab_id: + template_variables: + - name: "env" + values: + - "prod" + timeframe: "1w" + timezone: "America/New_York" + title: "Weekly Infrastructure Report" + id: "11111111-2222-3333-4444-555555555555" + type: schedule + included: + - attributes: + email: "user@example.com" + name: "Example User" + id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" + type: users + schema: + $ref: "#/components/schemas/ReportScheduleResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Toggle a report schedule + tags: + - Report Schedules + x-codegen-request-body-name: body + x-menu-order: 4 /api/v2/restriction_policy/{resource_id}: delete: description: Deletes the restriction policy associated with a specified resource. @@ -189668,6 +190672,8 @@ tags: [Dashboards documentation](https://docs.datadoghq.com/dashboards/) for more information. name: Dashboards + - description: Manage and run data observability monitors. + name: Data Observability - description: |- Data Access Controls in Datadog is a feature that allows administrators and access managers to regulate access to sensitive data. By defining Restricted Datasets, you can ensure that only specific teams or roles can diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 3d0c6d06967..6606f83ac22 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1564,6 +1564,14 @@ "description": "Get usage statistics for a single dashboard. The response includes view counts, the most recent view and edit times, widget counts, and the dashboard quality score. View-count fields depend on Real User Monitoring (RUM) and are `null` or `0` in orgs without RUM.", "summary": "Get usage stats for a dashboard" }, + "GetDataObservabilityMonitorRunStatus": { + "description": "Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.", + "summary": "Get data observability monitor run status" + }, + "RunDataObservabilityMonitor": { + "description": "Manually triggers a run for a data observability monitor. Only monitors that are not scheduled (manually-runnable) can be triggered this way.", + "summary": "Run a data observability monitor" + }, "GetAllDatasets": { "description": "Get all datasets that have been configured for an organization.", "summary": "Get all datasets" @@ -4309,12 +4317,34 @@ "request_description": "", "request_schema_description": "Request body for creating a report schedule." }, + "ListReportSchedules": { + "description": "List dashboard and integration dashboard report schedules for the organization.\nThe response is paginated and can be filtered by title, author UUID, or recipients.\nRequires the `generate_dashboard_reports` permission.", + "summary": "List report schedules" + }, + "GetReportSchedulesForResource": { + "description": "Get all report schedules that target a dashboard or integration dashboard resource.\nRequires a reporting read permission appropriate to the targeted resource type.", + "summary": "Get report schedules for a resource" + }, + "DeleteReportSchedule": { + "description": "Delete a report schedule by its unique identifier. The response returns the deleted schedule.\nRequires a reporting write permission appropriate to the targeted resource type and schedule ownership.", + "summary": "Delete a report schedule" + }, + "GetReportSchedule": { + "description": "Get a report schedule by its unique identifier.\nRequires a reporting read permission appropriate to the targeted resource type.", + "summary": "Get a report schedule" + }, "PatchReportSchedule": { "description": "Update an existing scheduled report by its identifier. The editable attributes\nare replaced with the supplied values; the targeted resource (`resource_id` and\n`resource_type`) cannot be changed after creation.\nRequires the `generate_dashboard_reports` permission and schedule ownership.", "summary": "Update a report schedule", "request_description": "", "request_schema_description": "Request body for updating a report schedule." }, + "ToggleReportSchedule": { + "description": "Activate or pause a report schedule by setting its status to `active` or `inactive`.\nRequires a reporting write permission appropriate to the targeted resource type and schedule ownership.", + "summary": "Toggle a report schedule", + "request_description": "", + "request_schema_description": "Request body for toggling a report schedule." + }, "DeleteRestrictionPolicy": { "description": "Deletes the restriction policy associated with a specified resource.", "summary": "Delete a restriction policy" diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index cd7dc74568c..875ced2b5d7 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -163,6 +163,10 @@ "name": "Dashboards", "description": "Get usage statistics for the dashboards in your organization, including view\ncounts, last-edit times, widget counts, and quality scores. See the\n[Dashboards documentation](https://docs.datadoghq.com/dashboards/) for more\ninformation." }, + "data-observability": { + "name": "Data Observability", + "description": "Manage and run data observability monitors." + }, "datasets": { "name": "Datasets", "description": "Data Access Controls in Datadog is a feature that allows administrators and access managers to regulate\naccess to sensitive data. By defining Restricted Datasets, you can ensure that only specific teams or roles can\nview certain types of telemetry (for example, logs, traces, metrics, and RUM data)."