Create entity scheduled report
POST/projects/{projectId}/entities/{entityId}/scheduledReports
Base URL: https://api.tinkermode.com
Create a new scheduled report for this entity.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain the key of a user or service account with permissions to create entity scheduled reports, or a project API key with admin permission.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
projectId | integer | Yes | The unique ID for a specified project. | |
entityId | string | Yes | Entity ID (unique within project) |
Request body
Content type: application/json
| Property | Type | Required | Constraints | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
answerEngine | object | Yes | ||||||||||||||||||||||
| ||||||||||||||||||||||||
contents | string | Yes | YAML configuration for report sections including entities and queries | |||||||||||||||||||||
description | string | No | Description of the scheduled report | |||||||||||||||||||||
directDestination | array<object> | No | Direct rooms to send the report to (required for Direct assistants) | |||||||||||||||||||||
| ||||||||||||||||||||||||
enabled | boolean | No | default: true | Whether the scheduled report is enabled | ||||||||||||||||||||
projectId | integer | Yes | ID of the project this report belongs to | |||||||||||||||||||||
reportSchedule | object | Yes | ||||||||||||||||||||||
| ||||||||||||||||||||||||
slackDestination | array<object> | No | Slack channels to send the report to (required for Slack assistants) | |||||||||||||||||||||
| ||||||||||||||||||||||||
teamsDestination | array<object> | No | MS Teams channels to send the report to (required for MS Teams assistants) | |||||||||||||||||||||
| ||||||||||||||||||||||||
title | string | Yes | Title of the scheduled report | |||||||||||||||||||||
Responses
201 New scheduled report successfully created.
Content type: application/json
| Property | Type | Required | Constraints | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
answerEngine | object | Yes | ||||||||||||||||||||||
| ||||||||||||||||||||||||
contents | string | Yes | YAML configuration for report sections | |||||||||||||||||||||
creationTime | string | No | format: date-time | When the report was created | ||||||||||||||||||||
description | string | No | Description of the scheduled report | |||||||||||||||||||||
directDestination | array<object> | No | Direct rooms to send the report to | |||||||||||||||||||||
| ||||||||||||||||||||||||
enabled | boolean | No | Whether the scheduled report is enabled | |||||||||||||||||||||
id | integer | Yes | Unique identifier for the scheduled report | |||||||||||||||||||||
projectId | integer | Yes | ID of the project this report belongs to | |||||||||||||||||||||
reportSchedule | object | Yes | ||||||||||||||||||||||
| ||||||||||||||||||||||||
slackDestination | array<object> | No | Slack channels to send the report to | |||||||||||||||||||||
| ||||||||||||||||||||||||
teamsDestination | array<object> | No | MS Teams channels to send the report to | |||||||||||||||||||||
| ||||||||||||||||||||||||
title | string | Yes | Title of the scheduled report | |||||||||||||||||||||
updateTime | string | No | format: date-time | When the report was last updated | ||||||||||||||||||||
401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 Request failed because of invalid data or denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |