List Report Schedules
Playground
GETEndpoint:
/api/content/v1/reportschedules
Query Parameters:
| Name | Type | Required | Default | Description | Enum Values |
|---|---|---|---|---|---|
| filter | string | false | ”USER” | Filter type for the schedules | - |
| title | string | false | "" | Filter by title | - |
| limit | integer | false | 0 | Number of items to return | - |
| skip | integer | false | 0 | Number of items to skip | - |
| orderBy | string | false | ”startDate” | Field to sort by | startDate, nextRunDate, title |
| isAscending | boolean | false | false | Sort in ascending order | - |
Create Report Schedule
Playground
POSTEndpoint:
/api/content/v1/reportschedules
Request Body: ReportScheduleInfo object
Example:
Delete Report Schedule by Page ID
Playground
DELETEEndpoint:
/api/content/v1/reportschedules
Query Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| pageId | integer | true | - | ID of the page to delete schedule for |
Get Report Schedule by ID
Playground
GETEndpoint:
/api/content/v1/reportschedules/{scheduleId}
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduleId | integer | true | ID of the schedule to retrieve |
Update Report Schedule
Playground
PUTEndpoint:
/api/content/v1/reportschedules/{scheduleId}
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduleId | integer | true | ID of the schedule to update |
Delete Report Schedule
Playground
DELETEEndpoint:
/api/content/v1/reportschedules/{scheduleId}
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduleId | integer | true | ID of the schedule to delete |
Enable/Disable Report Schedule
Playground
PUTEndpoint:
/api/content/v1/reportschedules/{scheduleId}/enabled
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduleId | integer | true | ID of the schedule |
Get Report History by Schedule ID
Playground
GETEndpoint:
/api/content/v1/reportschedules/{scheduleId}/history
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduleId | integer | true | ID of the schedule |
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| limit | integer | false | 100 | Number of items to return |
| skip | integer | false | 0 | Number of items to skip |
Build and Email Report
Playground
POSTEndpoint:
/api/content/v1/reportschedules/{scheduleId}/notifications
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduleId | integer | true | ID of the schedule |
Queue Build and Email Report
Playground
POSTEndpoint:
/api/content/v1/reportschedules/{scheduleId}/notifications/queue
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduleId | integer | true | ID of the schedule |
Queue Report Now
Playground
POSTEndpoint:
/api/content/v1/reportschedules/{scheduleId}/queue
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduleId | integer | true | ID of the schedule |
Resubscribe to Report
Playground
POSTEndpoint:
/api/content/v1/reportschedules/{scheduleId}/resubscribe
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduleId | integer | true | ID of the schedule |
| Name | Type | Required | Description |
|---|---|---|---|
| userId | integer | false | User ID |
| emailId | string | false | Email ID |
Send Report Now
Playground
POSTEndpoint:
/api/content/v1/reportschedules/{scheduleId}/sendnow
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduleId | integer | true | ID of the schedule |
Send Resubscribe Email
Playground
POSTEndpoint:
/api/content/v1/reportschedules/{scheduleId}/sendResubscribe
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduleId | integer | true | ID of the schedule |
Unsubscribe from Report
Playground
POSTEndpoint:
/api/content/v1/reportschedules/{scheduleId}/unsubscribe
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduleId | integer | true | ID of the schedule |
Delete Unsubscribed Recipient
Playground
DELETEEndpoint:
/api/content/v1/reportschedules/{scheduleId}/unsubscribe/recipient
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduleId | integer | true | ID of the schedule |
| Name | Type | Required | Description |
|---|---|---|---|
| userId | integer | false | User ID |
| emailId | string | false | Email ID |
Render Card for Email
Playground
POSTEndpoint:
/api/content/v1/reportschedules/card-email-data
Request Body: Array of integers (card IDs)
Example:
Get Created Report History
Playground
GETEndpoint:
/api/content/v1/reportschedules/created
Query Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| filter | string | false | ”USER” | Filter type |
| days | integer | false | 10 | Number of days to look back |
| isAscending | boolean | false | false | Sort order |
Enable/Disable Scheduled Report Emails
Playground
PUTEndpoint:
/api/content/v1/reportschedules/emails/enabled
Request Body: boolean
Example:
Get Extended Report History
Playground
GETEndpoint:
/api/content/v1/reportschedules/extendedHistory
Query Parameters:
| Name | Type | Required | Default | Description | Enum Values |
|---|---|---|---|---|---|
| filter | string | false | ”USER” | Filter type | - |
| days | integer | false | 10 | Number of days to look back | - |
| orderBy | string | false | ”startTime” | Field to sort by | reportTitle, startTime, endTime, automated, cardCount, attachmentCount, attachmentSize, emailSize |
| isAscending | boolean | false | false | Sort order | - |
Rerun Failed Scheduled Reports
Playground
POSTEndpoint:
/api/content/v1/reportschedules/failures/rerun
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| start | integer | true | Start timestamp |
| end | integer | true | End timestamp |
Get Report History
Playground
GETEndpoint:
/api/content/v1/reportschedules/history
Query Parameters:
| Name | Type | Required | Default | Description | Enum Values |
|---|---|---|---|---|---|
| filter | string | false | ”USER” | Filter type | - |
| limit | integer | false | 100 | Number of items to return | - |
| skip | integer | false | 0 | Number of items to skip | - |
| orderBy | string | false | ”startTime” | Field to sort by | reportTitle, startTime, endTime, automated, cardCount, attachmentCount, attachmentSize, emailSize |
| isAscending | boolean | false | false | Sort order | - |
| includeRecipientInfo | boolean | false | false | Include recipient information | - |
Get Report History by ID
Playground
GETEndpoint:
/api/content/v1/reportschedules/history/{id}
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | true | History entry ID |
Search Report History
Playground
POSTEndpoint:
/api/content/v1/reportschedules/history/search
Query Parameters:
| Name | Type | Required | Default | Description | Enum Values |
|---|---|---|---|---|---|
| filter | string | false | ”USER” | Filter type | - |
| limit | integer | false | 100 | Number of items to return | - |
| skip | integer | false | 0 | Number of items to skip | - |
| orderBy | string | false | ”startTime” | Field to sort by | reportTitle, startTime, endTime, automated, cardCount, attachmentCount, attachmentSize, emailSize |
| isAscending | boolean | false | false | Sort order | - |
Get Misconfigured Reports
Playground
GETEndpoint:
/api/content/v1/reportschedules/misconfigured
Query Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| limit | integer | false | 100 | Number of items to return |
| skip | integer | false | 0 | Number of items to skip |
Get Resources with Reports
Playground
GETEndpoint:
/api/content/v1/reportschedules/resources
Query Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| limit | integer | false | 100 | Number of items to return |
| skip | integer | false | 0 | Number of items to skip |
| title | string | false | "" | Filter by title |
Get Report Schedules by Resource ID
Playground
GETEndpoint:
/api/content/v1/reportschedules/resources/{resourceType}/{resourceId}
Path Parameters:
| Name | Type | Required | Description | Enum Values |
|---|---|---|---|---|
| resourceType | string | true | Type of resource | OPEN, PAGE, CARD, REPORT |
| resourceId | integer | true | ID of the resource | - |
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| showAll | boolean | false | false | Show all schedules |
Get Report Schedules Map
Playground
GETEndpoint:
/api/content/v1/reportschedules/sortby
Query Parameters:
| Name | Type | Required | Default | Description | Enum Values |
|---|---|---|---|---|---|
| filter | string | false | ”USER” | Filter type | - |
| title | string | false | "" | Filter by title | - |
| limit | integer | false | 0 | Number of items to return | - |
| skip | integer | false | 0 | Number of items to skip | - |
| orderBy | string | false | ”startDate” | Field to sort by | startDate, nextRunDate, title |
| isAscending | boolean | false | false | Sort order | - |
Get Report Schedule by View ID
Playground
GETEndpoint:
/api/content/v1/reportschedules/views/{viewId}
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| viewId | integer | true | ID of the view |
Send Report Now by View ID
Playground
POSTEndpoint:
/api/content/v1/reportschedules/views/{viewId}/sendNow
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| viewId | integer | true | ID of the view |
| Name | Type | Required | Description |
|---|---|---|---|
| attachmentInclude | boolean | false | Include attachments |
Send Report Now with Parameters by View ID
Playground
POSTEndpoint:
/api/content/v1/reportschedules/views/{viewId}/sendNowWithParams
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| viewId | integer | true | ID of the view |
| Name | Type | Required | Description |
|---|---|---|---|
| attachmentInclude | boolean | false | Include attachments |