get https://api.talkdeskapp.com/data/reports//files/
Get job report execution result
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 (report job execution result)
| Parameter | Type | Description | Required |
|---|---|---|---|
| job | object | "job" subdivides into: 1 - "ID" (string) - the job ID 2 - "name" (string) - report's name 3 - "timezone" (string) - timezone in IANA format in which the report timespan (from and to) will be applied 4 - "status" (string) - report status indicating the workflow progress. Allowed values: created, processing, uploading, done, failed, canceled, deleted. 5 - "format" (string) - format in which the report file will be created. Allowed values: csv, json, json_bulk 6 - "timespan" (object) - time range to filter for the report content. Subdivides into: 6.1 - "from" (string) - start date time filter for the records to be retrieved from the report 6.2 - "to" (string) - end datetime filter for the records to be retrieved from the report | no |
| _links | object | "_links" subdivides into: 1 - "self" (object) 1.1 - "href" (string) - Default: http://api-docs.talkdesk.org/data/reports/:type/jobs/:id 2 - "files" (object) 2.1 - "href" (string) - Default: http://api-docs.talkdesk.org/data/reports/:type/files/:id | no |
303 (report job execution result location)
Headers
| Parameter | Type | Description | Required |
|---|---|---|---|
| Location | string | The job results location. Default: https://s3.amazonaws.com/td-sandbox-public-api-mock/calls.json | no |
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
| job | object | "job" subdivides into: 1 - "ID" (string) - the job ID 2 - "name" (string) - report's name 3 - "timezone" (string) - timezone in IANA format in which the report timespan (from and to) will be applied 4 - "status" (string) - report status indicating the workflow progress. Allowed values: created, processing, uploading, done, failed, canceled, deleted. 5 - "format" (string) - format in which the report file will be created. Allowed values: csv, json, json_bulk 6 - "timespan" (object) - time range to filter for the report content. Subdivides into: 6.1 - "from" (string) - start date time filter for the records to be retrieved from the report 6.2 - "to" (string) - end datetime filter for the records to be retrieved from the report | no |
| _links | object | "_links" subdivides into: 1 - "self" (object) 1.1 - "href" (string) - Default: http://api-docs.talkdesk.org/data/reports/:type/jobs/:id 2 - "files" (object) 2.1 - "href" (string) - Default: http://api-docs.talkdesk.org/data/reports/:type/files/:id | no |
400 (report type is invalid), 401 (unauthorized), 403 (inputs misconfiguration), 404 (report job not found)
| 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 and Data Latency
You can't download a custom or default report or dashboard created in Explore via the Explore API. The reports that can be extracted via Explore API are:
- Calls Report .
- User Status Report.
- Studio Flow Execution Report.
- Contacts Report.
- Ring Attempts Report.
- Outbound Dialer Calls Report.
- Quality Management Evaluation Analysis Report.
- Feedback Report.
- Feedback Flow Report.
- WFM Schedule Adherence Report.
- Messaging Contacts Report.
- Messaging Traffic Report.
The data obtained via Explore API has a 60-second delay in relation to real time.
A report file can be downloaded as many times as required after it is executed. The file will be available for download for 30 days.
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.