get https://api.talkdeskapp.com/data/reports//jobs
Get all jobs from a report type
Transport Layer Security 1.2 (TLS) is the minimum version of the TLS protocol allowed for use on the Explore API endpoints.
Scope
data-reports:read
Body Response - Schema
200 (an array of jobs)
| Parameter | Type | Description | Required |
|---|---|---|---|
| total | integer | n/a | no |
| count | integer | n/a | no |
| _embedded | object | "_embedded" subdivides into: 1 - "jobs" (array[object]) 1.1 - "id" (string) - the job ID 1.2 - "name" (string) - report's name 1.3 - "timezone" (string) - report's name 1.4 - "status" (string) - Report status indicating the workflow progress. Allowed values: "created", "processing", "uploading", "done", "failed", "canceled", "deleted" 1.5 - "format" (string) - format in which the report file will be created. Allowed values: "csv", "json", "json_bulk" 1.6 - "timespan" (object) - time range to filter for the report content. 1.6.1 - "from" (string ) - start datetime filter for the records to be retrieved from the report. 1.6.2 - "to" (string ) - end datetime filter for the records to be retrieved from the report. 1.7 - "_links" (object) 1.7.1 - "self" (object) 1.7.1.1 - "href" (string) - default: http://api-docs.talkdesk.org/data/reports/:type/jobs/:id 1.7.2.1 - "files" (object) 1.7.2.1.1 - "href" (string) - default: http://api-docs.talkdesk.org/data/reports/:type/files/:id | no |
| _links | object | "_links" subdivides into: 1.7 - "self" (object) - required. 1.7.1. - "href" (string) 1.7.2 - "next"(object) 1.7.2.1 - "href"(string) 1.7.3 - "prev"(object) 1.7.3.1 - "href"(string) | no |
400 (bad request), 401 (unauthorized), 403 (inputs misconfiguration), 404 (report file not found), 503 (unable to audit operation)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Report Availability
Only reports created in the last 30 days will be listed.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.