REST APIWebhooks and automationReportSchedules
ReportSchedules
ReportSchedules: list, get, create, update and delete, plus batch operations.
- 8 operations
- 16 fields
- Schema ReportSchedule
- GraphQL: reportSchedule
The summaries on this page are generated from the specification; written descriptions come with the next releases of the reference.
| Method | Path | Operation |
|---|---|---|
| GET | /entities/ReportSchedules | List ReportSchedules |
| POST | /entities/ReportSchedules | Create ReportSchedule |
| GET | /entities/ReportSchedules/{id} | Get ReportSchedule |
| PATCH | /entities/ReportSchedules/{id} | Update ReportSchedule |
| DEL | /entities/ReportSchedules/{id} | Delete ReportSchedule |
| POST | /entities/ReportSchedules/batch-modify | Create or update ReportSchedules in a batch |
| POST | /entities/ReportSchedules/batch-delete | Delete ReportSchedules in a batch |
| POST | /entities/ReportSchedules/batch-restore | Restore deleted ReportSchedules |
GET List ReportSchedules
Returns the ReportSchedules the API application can read, one page at a time. In the list envelope, total counts every match and page_info pages through them.
Query parameters
| Name | Type | Description |
|---|---|---|
include-deleted | boolean | Include soft-deleted records. Lists only; get-by-id refuses it. |
first | integer | Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117. |
last | integer | Return the last N records of the result; together with first, the last N of the first M. Maximum 100. |
before | string | Cursor from page_info.start_cursor, to page backwards. URL-encode it. |
after | string | Cursor from page_info.end_cursor of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space. |
expand | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in account_relations.account. |
order-by | string | Fields to sort by, comma-separated. A leading - sorts descending, as in -modified; dotted paths sort by related fields. |
filter | object | filter[field]=value. Separate several values with a raw comma (OR), as in filter[name]=north,south. Encode a comma that belongs to a value as %2C. URLSearchParams and Python requests encode every comma, so build the filter part of the query string yourself. Dotted paths filter on related records, as in filter[owner.email]. Encode a + in a value as %2B: query values are form-decoded, so a raw + becomes a space. |
filter-op | object | filter-op[field]=operator, one per field: eq (the default), ieq, not-eq, not-ieq, contains, icontains, starts, istarts, ends, iends, gt, gte, lt, lte, between, null, not-null, empty and not-empty. null, not-null, empty and not-empty take no filter value; gt, gte, lt and lte take exactly one. |
load-only | string | Fields to return, comma-separated (raw or encoded commas both work here); dots select nested fields, as in owner.id. All fields are returned without it. Lists only: get-by-id refuses it with HTTP 400, code 118. |
Responses
200 Page of ReportSchedule records.: success, total, page_info, data 400 Bad request 401 Not authenticated 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules?first=10' \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET"fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules?first=10', {
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
}
})import os
import requests
response = requests.get(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules",
params={
"first": "10"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)POST Create ReportSchedule
Creates one record and answers 201 with it.
Query parameters
| Name | Type | Description |
|---|---|---|
validation-level | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |
Request body
The new record's fields. Relations are set by id. Schema createReportScheduleInput; the fields are in ReportSchedule fields. Required: owner_id, report_id, settings.
Responses
201 The created ReportSchedule record.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules' \
--request POST \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
--header 'Content-Type: application/json' \
--data '{
"owner_id": "37000000-0000-4000-a000-000000000001",
"report_id": "e8000000-0000-4000-a000-000000000001",
"settings": {}
}'fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules', {
method: 'POST',
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
'Content-Type': 'application/json'
},
body: JSON.stringify({
owner_id: '37000000-0000-4000-a000-000000000001',
report_id: 'e8000000-0000-4000-a000-000000000001',
settings: {}
})
})import os
import requests
response = requests.post(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules",
headers={
"Content-Type": "application/json"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
json={
"owner_id": "37000000-0000-4000-a000-000000000001",
"report_id": "e8000000-0000-4000-a000-000000000001",
"settings": {}
}
)GET Get ReportSchedule
Returns one record by id. expand returns related records inline instead of their URIs.
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | Id of the ReportSchedule record to retrieve. Required |
Query parameters
| Name | Type | Description |
|---|---|---|
expand | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts. |
Responses
200 The ReportSchedule record.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/73000000-0000-4000-a000-000000000001?expand=owner' \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET"fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/73000000-0000-4000-a000-000000000001?expand=owner', {
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
}
})import os
import requests
response = requests.get(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/73000000-0000-4000-a000-000000000001",
params={
"expand": "owner"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)PATCH Update ReportSchedule
Changes the fields you send and leaves the rest as they are; there is no PUT.
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | Id of the ReportSchedule record to update. Required |
Query parameters
| Name | Type | Description |
|---|---|---|
validation-level | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |
Request body
The fields to change. Schema updateReportScheduleInput; the fields are in ReportSchedule fields.
Responses
200 The changed ReportSchedule record.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/73000000-0000-4000-a000-000000000001' \
--request PATCH \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
--header 'Content-Type: application/json' \
--data '{
"owner_id": "37000000-0000-4000-a000-000000000001"
}'fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/73000000-0000-4000-a000-000000000001', {
method: 'PATCH',
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
'Content-Type': 'application/json'
},
body: JSON.stringify({
owner_id: '37000000-0000-4000-a000-000000000001'
})
})import os
import requests
response = requests.patch(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/73000000-0000-4000-a000-000000000001",
headers={
"Content-Type": "application/json"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
json={
"owner_id": "37000000-0000-4000-a000-000000000001"
}
)DEL Delete ReportSchedule
Deletes one record and answers with its id.
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | Id of the ReportSchedule record to delete. Required |
Responses
200 Deletion confirmation.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/73000000-0000-4000-a000-000000000001' \
--request DELETE \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET"fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/73000000-0000-4000-a000-000000000001', {
method: 'DELETE',
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
}
})import os
import requests
response = requests.delete(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/73000000-0000-4000-a000-000000000001",
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)POST Create or update ReportSchedules in a batch
An item with an id updates that record; an item without one creates a record. By default one invalid item fails the whole call with HTTP 422 and nothing is written; with rollback-method=1 the response has an id or an error for each item, in input order.
Query parameters
| Name | Type | Description |
|---|---|---|
validation-level | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |
rollback-method | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. |
Request body
A JSON array of records: an item with an id updates, an item without one creates. Schema batchReportScheduleInput; the fields are in ReportSchedule fields. Required: owner_id, report_id, settings.
Responses
200 Result per item, in request order: the id of the created or updated record, or the error.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/batch-modify' \
--request POST \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
--header 'Content-Type: application/json' \
--data '[
{
"owner_id": "37000000-0000-4000-a000-000000000001",
"report_id": "e8000000-0000-4000-a000-000000000001",
"settings": {}
},
{
"id": "73000000-0000-4000-a000-000000000001",
"owner_id": "37000000-0000-4000-a000-000000000001"
}
]'fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/batch-modify', {
method: 'POST',
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
'Content-Type': 'application/json'
},
body: JSON.stringify([
{
owner_id: '37000000-0000-4000-a000-000000000001',
report_id: 'e8000000-0000-4000-a000-000000000001',
settings: {}
},
{
id: '73000000-0000-4000-a000-000000000001',
owner_id: '37000000-0000-4000-a000-000000000001'
}
])
})import os
import requests
response = requests.post(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/batch-modify",
headers={
"Content-Type": "application/json"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
json=[
{
"owner_id": "37000000-0000-4000-a000-000000000001",
"report_id": "e8000000-0000-4000-a000-000000000001",
"settings": {}
},
{
"id": "73000000-0000-4000-a000-000000000001",
"owner_id": "37000000-0000-4000-a000-000000000001"
}
]
)POST Delete ReportSchedules in a batch
Deletes the records whose ids are in the body, a JSON array. By default an unknown id fails the whole call with HTTP 404.
Query parameters
| Name | Type | Description |
|---|---|---|
rollback-method | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. |
Request body
A JSON array of ids.
Responses
200 Result per id, in request order: the id of the deleted record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/batch-delete' \
--request POST \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
--header 'Content-Type: application/json' \
--data '[
"73000000-0000-4000-a000-000000000001",
"73000000-0000-4000-a000-000000000002"
]'fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/batch-delete', {
method: 'POST',
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
'Content-Type': 'application/json'
},
body: JSON.stringify(['73000000-0000-4000-a000-000000000001', '73000000-0000-4000-a000-000000000002'])
})import os
import requests
response = requests.post(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/batch-delete",
headers={
"Content-Type": "application/json"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
json=[
"73000000-0000-4000-a000-000000000001",
"73000000-0000-4000-a000-000000000002"
]
)POST Restore deleted ReportSchedules
Restores the deleted records whose ids are in the body, a JSON array.
Query parameters
| Name | Type | Description |
|---|---|---|
rollback-method | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. |
Request body
A JSON array of ids.
Responses
200 Result per id, in request order: the id of the restored record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/batch-restore' \
--request POST \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
--header 'Content-Type: application/json' \
--data '[
"73000000-0000-4000-a000-000000000001",
"73000000-0000-4000-a000-000000000002"
]'fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/batch-restore', {
method: 'POST',
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
'Content-Type': 'application/json'
},
body: JSON.stringify(['73000000-0000-4000-a000-000000000001', '73000000-0000-4000-a000-000000000002'])
})import os
import requests
response = requests.post(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/ReportSchedules/batch-restore",
headers={
"Content-Type": "application/json"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
json=[
"73000000-0000-4000-a000-000000000001",
"73000000-0000-4000-a000-000000000002"
]
)ReportSchedule fields
| Field | Type | Notes |
|---|---|---|
id | uuid | Read-only Unique identifier of entity. |
owner_id | uuid → Clients | Required on create Id of the owning user. |
report_id | uuid → Reports | Required on create Id of the scheduled report. |
settings | object | Required on create Schedule configuration: cadence, timezone, recipients, email body and report attachment options. |
revision | integer | Revision when entity was lastly changed. |
documents | array of uri → CloudObjectRelations | Files attached to scheduled emails sent for this report. |
is_delete_protected | boolean | Read-only True when the record is protected against deletion because it must always exist in the space. |
is_deleted | boolean | Read-only Specifies if the entity is considered deleted. |
modified | date-time | Read-only Last modification time. |
created | date-time | Read-only Creation time. |
owner | uri → Clients | Read-only User who owns the schedule. |
report | uri → Reports | Read-only Report whose delivery is scheduled. |
sender_email | string | Read-only Email address used to send the scheduled report (company email when configured, otherwise the owner's personal email). |
report_name | string | Read-only Name of the scheduled report (mirror of the linked Report.name). |
report_owner_id | uuid | Read-only Id of the user who owns the scheduled report. |
Show all 16 fields
| Field | Type | Notes |
|---|---|---|
report_type | integer | Read-only Kind of the scheduled report (e.g.0 TableReport · 1 DashboardReport · 2 ForecastReport · 3 AdvancedReport |
Custom fields appear in your space's live spec: fetch it with your credentials.
Errors
Every error body has success: false, http_status, code, name and message. Branch on code: the status alone does not tell a missing permission from a bad parameter. All codes: error codes; how to handle them: Errors.
| HTTP | When |
|---|---|
| 400 | Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check code. |
| 401 | Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). |
| 404 | No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE). |
| 422 | Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written. |
| 429 | Too many requests (code 182). Wait for the seconds in Retry-After, then retry. |
| 500 | Unexpected server error (code 1000, ERROR_UNKNOWN). |