Skip to main content

List Report Schedules

Playground

Method: GET
Endpoint: /api/content/v1/reportschedules
Query Parameters: Example:
Responses:

Create Report Schedule

Playground

Method: POST
Endpoint: /api/content/v1/reportschedules
Request Body: ReportScheduleInfo object Example:
Responses:

Delete Report Schedule by Page ID

Playground

Method: DELETE
Endpoint: /api/content/v1/reportschedules
Query Parameters: Example:
Responses:

Get Report Schedule by ID

Playground

Method: GET
Endpoint: /api/content/v1/reportschedules/{scheduleId}
Path Parameters: Example:
Responses:

Update Report Schedule

Playground

Method: PUT
Endpoint: /api/content/v1/reportschedules/{scheduleId}
Path Parameters: Request Body: ReportScheduleInfo object Example:
Responses:

Delete Report Schedule

Playground

Method: DELETE
Endpoint: /api/content/v1/reportschedules/{scheduleId}
Path Parameters: Example:
Responses:

Enable/Disable Report Schedule

Playground

Method: PUT
Endpoint: /api/content/v1/reportschedules/{scheduleId}/enabled
Path Parameters: Request Body: boolean Example:
Responses:

Get Report History by Schedule ID

Playground

Method: GET
Endpoint: /api/content/v1/reportschedules/{scheduleId}/history
Path Parameters: Query Parameters: Example:
Responses:

Build and Email Report

Playground

Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/notifications
Path Parameters: Request Body: Array of ReportRecipient objects Example:
Responses:

Queue Build and Email Report

Playground

Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/notifications/queue
Path Parameters: Request Body: Array of ReportRecipient objects Example:
Responses:

Queue Report Now

Playground

Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/queue
Path Parameters: Request Body: Array of ReportScheduleRecipient objects Example:
Responses:

Resubscribe to Report

Playground

Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/resubscribe
Path Parameters: Query Parameters: Example:
Responses:

Send Report Now

Playground

Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/sendnow
Path Parameters: Request Body: Array of ReportScheduleRecipient objects Example:
Responses:

Send Resubscribe Email

Playground

Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/sendResubscribe
Path Parameters: Request Body: Array of ReportScheduleRecipient objects Example:
Responses:

Unsubscribe from Report

Playground

Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/unsubscribe
Path Parameters: Example:
Responses:

Delete Unsubscribed Recipient

Playground

Method: DELETE
Endpoint: /api/content/v1/reportschedules/{scheduleId}/unsubscribe/recipient
Path Parameters: Query Parameters: Example:
Responses:

Render Card for Email

Playground

Method: POST
Endpoint: /api/content/v1/reportschedules/card-email-data
Request Body: Array of integers (card IDs) Example:
Responses:

Get Created Report History

Playground

Method: GET
Endpoint: /api/content/v1/reportschedules/created
Query Parameters: Example:
Responses:

Enable/Disable Scheduled Report Emails

Playground

Method: PUT
Endpoint: /api/content/v1/reportschedules/emails/enabled
Request Body: boolean Example:
Responses:

Get Extended Report History

Playground

Method: GET
Endpoint: /api/content/v1/reportschedules/extendedHistory
Query Parameters: Example:
Responses:

Rerun Failed Scheduled Reports

Playground

Method: POST
Endpoint: /api/content/v1/reportschedules/failures/rerun
Query Parameters: Example:
Responses:

Get Report History

Playground

Method: GET
Endpoint: /api/content/v1/reportschedules/history
Query Parameters: Example:
Responses:

Get Report History by ID

Playground

Method: GET
Endpoint: /api/content/v1/reportschedules/history/{id}
Path Parameters: Example:
Responses:

Search Report History

Playground

Method: POST
Endpoint: /api/content/v1/reportschedules/history/search
Query Parameters: Request Body: ReportLogSearchCriteria object Example:
Responses:

Get Misconfigured Reports

Playground

Method: GET
Endpoint: /api/content/v1/reportschedules/misconfigured
Query Parameters: Example:
Responses:

Get Resources with Reports

Playground

Method: GET
Endpoint: /api/content/v1/reportschedules/resources
Query Parameters: Example:
Responses:

Get Report Schedules by Resource ID

Playground

Method: GET
Endpoint: /api/content/v1/reportschedules/resources/{resourceType}/{resourceId}
Path Parameters: Query Parameters: Example:
Responses:

Get Report Schedules Map

Playground

Method: GET
Endpoint: /api/content/v1/reportschedules/sortby
Query Parameters: Example:
Responses:

Get Report Schedule by View ID

Playground

Method: GET
Endpoint: /api/content/v1/reportschedules/views/{viewId}
Path Parameters: Example:
Responses:

Send Report Now by View ID

Playground

Method: POST
Endpoint: /api/content/v1/reportschedules/views/{viewId}/sendNow
Path Parameters: Query Parameters: Request Body: Array of ReportScheduleRecipient objects Example:
Responses:

Send Report Now with Parameters by View ID

Playground

Method: POST
Endpoint: /api/content/v1/reportschedules/views/{viewId}/sendNowWithParams
Path Parameters: Query Parameters: Request Body: ResourceSendNowInfo object Example:
Responses: