get https://api.talkdeskapp.com/data/reports//files/
Get job report execution result
Scope
data-reports:read
Body Response - Schema
302 (data report job execution result location with target format file containing entries information)
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 |
|---|---|---|---|
| total | number | n/a | no |
| type | string | n/a | no |
400 (report type is invalid), 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 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.