Documentation Index
Fetch the complete documentation index at: https://domoinc-arun-raj-connectors-domo-479695-remove-crime-report.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
List Report Schedules
Method: GET
Endpoint: /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 | - |
Example:
curl --request GET \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
[
{
"id": 123456,
"reportViewId": 789012,
"pageId": 345678,
"title": "Monthly Sales Report",
"viewName": "Sales Dashboard",
"type": "RECURRING",
"ownerId": 901234,
"embedViewId": 567890,
"owner": true,
"cardCount": 5,
"recipientCount": 10,
"cardId": 234567,
"schedule": {
"frequency": "MONTHLY",
"daysToRun": "1",
"hourOfDay": 9,
"minOfHour": 0,
"timezone": "America/New_York",
"enabled": true
}
}
]
Create Report Schedule
Method: POST
Endpoint: /api/content/v1/reportschedules
Request Body: ReportScheduleInfo object
Example:
curl --request POST \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>' \
--data '{
"title": "Weekly Performance Report",
"pageId": 345678,
"viewId": 789012,
"schedule": {
"frequency": "WEEKLY",
"daysToRun": "MON",
"hourOfDay": 8,
"minOfHour": 0,
"timezone": "America/New_York",
"enabled": true,
"additionalRecipients": [
{
"type": "EMAIL",
"value": "user@example.com"
}
]
},
"attachmentInclude": true
}'
Responses:
{
"id": 123457,
"reportViewId": 789012,
"pageId": 345678,
"title": "Weekly Performance Report",
"schedule": {
"frequency": "WEEKLY",
"daysToRun": "MON",
"hourOfDay": 8,
"minOfHour": 0,
"enabled": true,
"nextRunDate": 1700481600000
}
}
Delete Report Schedule by Page ID
Method: DELETE
Endpoint: /api/content/v1/reportschedules
Query Parameters:
| Name | Type | Required | Default | Description |
|---|
| pageId | integer | true | - | ID of the page to delete schedule for |
Example:
curl --request DELETE \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
Get Report Schedule by ID
Method: GET
Endpoint: /api/content/v1/reportschedules/{scheduleId}
Path Parameters:
| Name | Type | Required | Description |
|---|
| scheduleId | integer | true | ID of the schedule to retrieve |
Example:
curl --request GET \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/123456' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
{
"id": 123456,
"reportViewId": 789012,
"pageId": 345678,
"title": "Monthly Sales Report",
"schedule": {
"frequency": "MONTHLY",
"daysToRun": "1",
"hourOfDay": 9,
"minOfHour": 0,
"timezone": "America/New_York",
"enabled": true
}
}
Update Report Schedule
Method: PUT
Endpoint: /api/content/v1/reportschedules/{scheduleId}
Path Parameters:
| Name | Type | Required | Description |
|---|
| scheduleId | integer | true | ID of the schedule to update |
Request Body: ReportScheduleInfo object
Example:
curl --request PUT \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/123456' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>' \
--data '{
"title": "Updated Monthly Sales Report",
"schedule": {
"frequency": "MONTHLY",
"daysToRun": "15",
"hourOfDay": 10,
"minOfHour": 30,
"timezone": "America/New_York",
"enabled": true
}
}'
Responses:
{
"id": 123456,
"title": "Updated Monthly Sales Report",
"schedule": {
"frequency": "MONTHLY",
"daysToRun": "15",
"hourOfDay": 10,
"minOfHour": 30,
"timezone": "America/New_York",
"enabled": true,
"nextRunDate": 1701864600000
}
}
Delete Report Schedule
Method: DELETE
Endpoint: /api/content/v1/reportschedules/{scheduleId}
Path Parameters:
| Name | Type | Required | Description |
|---|
| scheduleId | integer | true | ID of the schedule to delete |
Example:
curl --request DELETE \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/123456' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
Enable/Disable Report Schedule
Method: PUT
Endpoint: /api/content/v1/reportschedules/{scheduleId}/enabled
Path Parameters:
| Name | Type | Required | Description |
|---|
| scheduleId | integer | true | ID of the schedule |
Request Body: boolean
Example:
curl --request PUT \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/123456/enabled' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>' \
--data true
Responses:
Get Report History by Schedule ID
Method: GET
Endpoint: /api/content/v1/reportschedules/{scheduleId}/history
Path Parameters:
| Name | Type | Required | Description |
|---|
| scheduleId | integer | true | ID of the schedule |
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 |
Example:
curl --request GET \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/123456/history' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
[
{
"id": 789012,
"reportId": 123456,
"reportTitle": "Monthly Sales Report",
"reportSubject": "Sales Report for November 2024",
"startTime": "2024-11-01T09:00:00Z",
"endTime": "2024-11-01T09:05:00Z",
"automated": true,
"cardCount": 5,
"attachmentCount": 2,
"attachmentSize": 1024000,
"emailSize": 1536000,
"status": "success",
"recipients": [
{
"userId": 901234,
"displayName": "John Doe",
"emailAddress": "john.doe@example.com"
}
]
}
]
Build and Email Report
Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/notifications
Path Parameters:
| Name | Type | Required | Description |
|---|
| scheduleId | integer | true | ID of the schedule |
Request Body: Array of ReportRecipient objects
Example:
curl --request POST \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/123456/notifications' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>' \
--data '[
{
"userId": 901234,
"displayName": "John Doe",
"emailAddress": "john.doe@example.com"
}
]'
Responses:
Queue Build and Email Report
Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/notifications/queue
Path Parameters:
| Name | Type | Required | Description |
|---|
| scheduleId | integer | true | ID of the schedule |
Request Body: Array of ReportRecipient objects
Example:
curl --request POST \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/123456/notifications/queue' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>' \
--data '[
{
"userId": 901234,
"displayName": "John Doe",
"emailAddress": "john.doe@example.com"
}
]'
Responses:
Queue Report Now
Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/queue
Path Parameters:
| Name | Type | Required | Description |
|---|
| scheduleId | integer | true | ID of the schedule |
Request Body: Array of ReportScheduleRecipient objects
Example:
curl --request POST \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/123456/queue' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>' \
--data '[
{
"type": "EMAIL",
"value": "john.doe@example.com"
}
]'
Responses:
Resubscribe to Report
Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/resubscribe
Path Parameters:
| Name | Type | Required | Description |
|---|
| scheduleId | integer | true | ID of the schedule |
Query Parameters:
| Name | Type | Required | Description |
|---|
| userId | integer | false | User ID |
| emailId | string | false | Email ID |
Example:
curl --request POST \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/123456/resubscribe' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
Send Report Now
Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/sendnow
Path Parameters:
| Name | Type | Required | Description |
|---|
| scheduleId | integer | true | ID of the schedule |
Request Body: Array of ReportScheduleRecipient objects
Example:
curl --request POST \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/123456/sendnow' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>' \
--data '[
{
"type": "EMAIL",
"value": "john.doe@example.com"
}
]'
Responses:
Send Resubscribe Email
Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/sendResubscribe
Path Parameters:
| Name | Type | Required | Description |
|---|
| scheduleId | integer | true | ID of the schedule |
Request Body: Array of ReportScheduleRecipient objects
Example:
curl --request POST \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/123456/sendResubscribe' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>' \
--data '[
{
"type": "EMAIL",
"value": "john.doe@example.com"
}
]'
Responses:
Unsubscribe from Report
Method: POST
Endpoint: /api/content/v1/reportschedules/{scheduleId}/unsubscribe
Path Parameters:
| Name | Type | Required | Description |
|---|
| scheduleId | integer | true | ID of the schedule |
Example:
curl --request POST \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/123456/unsubscribe' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
Delete Unsubscribed Recipient
Method: DELETE
Endpoint: /api/content/v1/reportschedules/{scheduleId}/unsubscribe/recipient
Path Parameters:
| Name | Type | Required | Description |
|---|
| scheduleId | integer | true | ID of the schedule |
Query Parameters:
| Name | Type | Required | Description |
|---|
| userId | integer | false | User ID |
| emailId | string | false | Email ID |
Example:
curl --request DELETE \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/123456/unsubscribe/recipient' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
Render Card for Email
Method: POST
Endpoint: /api/content/v1/reportschedules/card-email-data
Request Body: Array of integers (card IDs)
Example:
curl --request POST \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/card-email-data' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>' \
--data '[
123,
456,
789
]'
Responses:
{
"additionalProperties": {
"title": "Sample Card",
"encodedImage": "base64string",
"encodedImageId": "img123",
"timeframeLabel": "Last 30 Days",
"summaryNumberValue": "10,000",
"summaryNumberLabel": "Total Sales",
"htmlContent": "<div>Card content</div>",
"cardType": "kpi",
"cardLink": "https://instance.domo.com/cards/123",
"pdpEnabled": true,
"certified": true,
"companyCertified": false
}
}
Get Created Report History
Method: GET
Endpoint: /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 |
Example:
curl --request GET \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/created' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
[
{
"reportId": 123456,
"reportTitle": "New Report",
"ownerId": 789,
"created": "2024-11-14T10:00:00Z",
"resourceType": "PAGE",
"resourceId": 456,
"resourceName": "Dashboard"
}
]
Enable/Disable Scheduled Report Emails
Method: PUT
Endpoint: /api/content/v1/reportschedules/emails/enabled
Request Body: boolean
Example:
curl --request PUT \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/emails/enabled' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>' \
--data true
Responses:
Get Extended Report History
Method: GET
Endpoint: /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 | - |
Example:
curl --request GET \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/extendedHistory' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
[
{
"id": 123456,
"reportId": 789012,
"reportTitle": "Extended Report",
"reportSubject": "Extended Report Details",
"startTime": "2024-11-14T10:00:00Z",
"endTime": "2024-11-14T10:05:00Z",
"automated": true,
"cardCount": 5,
"attachmentCount": 2,
"attachmentSize": 1024000,
"emailSize": 1536000,
"status": "success",
"ownerId": 901234,
"recipientCount": 10,
"resourceType": "PAGE",
"resourceId": 345678,
"resourceName": "Sales Dashboard"
}
]
Rerun Failed Scheduled Reports
Method: POST
Endpoint: /api/content/v1/reportschedules/failures/rerun
Query Parameters:
| Name | Type | Required | Description |
|---|
| start | integer | true | Start timestamp |
| end | integer | true | End timestamp |
Example:
curl --request POST \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/failures/rerun' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
Get Report History
Method: GET
Endpoint: /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 | - |
Example:
curl --request GET \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/history' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
[
{
"id": 123456,
"reportId": 789012,
"reportTitle": "History Report",
"startTime": "2024-11-14T10:00:00Z",
"endTime": "2024-11-14T10:05:00Z",
"automated": true,
"cardCount": 5,
"status": "success",
"recipients": [
{
"userId": 901234,
"displayName": "John Doe",
"emailAddress": "john.doe@example.com"
}
]
}
]
Get Report History by ID
Method: GET
Endpoint: /api/content/v1/reportschedules/history/{id}
Path Parameters:
| Name | Type | Required | Description |
|---|
| id | integer | true | History entry ID |
Example:
curl --request GET \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/history/123456' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
{
"id": 123456,
"reportTitle": "Specific History Report",
"startTime": "2024-11-14T10:00:00Z",
"endTime": "2024-11-14T10:05:00Z",
"status": "success"
}
Search Report History
Method: POST
Endpoint: /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 | - |
Request Body: ReportLogSearchCriteria object
Example:
curl --request POST \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/history/search' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>' \
--data '{
"includeTitleClause": true,
"titleSearchText": "Sales",
"includeStatusClause": true,
"status": "success",
"includeTypeClause": true,
"isAutomated": true,
"includeScheduleIdClause": false
}'
Responses:
[
{
"id": 123456,
"reportTitle": "Sales Report",
"startTime": "2024-11-14T10:00:00Z",
"endTime": "2024-11-14T10:05:00Z",
"automated": true,
"status": "success"
}
]
Method: GET
Endpoint: /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 |
Example:
curl --request GET \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/misconfigured' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
[
{
"id": 123456,
"title": "Misconfigured Report",
"schedule": {
"frequency": "MONTHLY",
"enabled": false
},
"active": false
}
]
Get Resources with Reports
Method: GET
Endpoint: /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 |
Example:
curl --request GET \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/resources' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
[
{
"resourceId": 123456,
"title": "Sales Dashboard",
"type": "PAGE"
}
]
Get Report Schedules by Resource ID
Method: GET
Endpoint: /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 | - |
Query Parameters:
| Name | Type | Required | Default | Description |
|---|
| showAll | boolean | false | false | Show all schedules |
Example:
curl --request GET \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/resources/PAGE/123456' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
[
{
"id": 123456,
"title": "Resource Report",
"schedule": {
"frequency": "WEEKLY",
"enabled": true
}
}
]
Get Report Schedules Map
Method: GET
Endpoint: /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 | - |
Example:
curl --request GET \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/sortby' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
[
{
"id": 123456,
"title": "Sales Report",
"schedule": {
"frequency": "WEEKLY",
"enabled": true
}
}
]
Get Report Schedule by View ID
Method: GET
Endpoint: /api/content/v1/reportschedules/views/{viewId}
Path Parameters:
| Name | Type | Required | Description |
|---|
| viewId | integer | true | ID of the view |
Example:
curl --request GET \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/views/123456' \
--header 'X-DOMO-Developer-Token: Bearer <token>'
Responses:
{
"id": 123456,
"title": "View Report",
"schedule": {
"frequency": "WEEKLY",
"enabled": true
}
}
Send Report Now by View ID
Method: POST
Endpoint: /api/content/v1/reportschedules/views/{viewId}/sendNow
Path Parameters:
| Name | Type | Required | Description |
|---|
| viewId | integer | true | ID of the view |
Query Parameters:
| Name | Type | Required | Description |
|---|
| attachmentInclude | boolean | false | Include attachments |
Request Body: Array of ReportScheduleRecipient objects
Example:
curl --request POST \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/views/123456/sendNow' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>' \
--data '[
{
"type": "EMAIL",
"value": "user@example.com"
}
]'
Responses:
Send Report Now with Parameters by View ID
Method: POST
Endpoint: /api/content/v1/reportschedules/views/{viewId}/sendNowWithParams
Path Parameters:
| Name | Type | Required | Description |
|---|
| viewId | integer | true | ID of the view |
Query Parameters:
| Name | Type | Required | Description |
|---|
| attachmentInclude | boolean | false | Include attachments |
Request Body: ResourceSendNowInfo object
Example:
curl --request POST \
--url 'https://{instance}.domo.com/api/content/v1/reportschedules/views/123456/sendNowWithParams' \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: Bearer <token>' \
--data '{
"recipients": [
{
"type": "EMAIL",
"value": "user@example.com"
}
],
"alertActionId": 789012,
"emailParams": {
"param1": "value1"
}
}'
Responses: