Check a Report Status

Get job report execution details

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

👍

Report Statuses

  • CREATED: the report job is enqueued for processing.
  • PROCESSING: the report job is being processed.
  • DONE: the report job is completed (its file can be accessed).
  • FAILED: report job failed due to an error (its file cannot be accessed).
  • DELETED: the report job has been deleted (its file cannot be accessed).

🚧

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)

ParameterTypeDescriptionRequired
jobobject"job" subdivides into:

1 - "id" (string) - the job ID

2 - "name" (string) - report's name

3 - "timezone" (string) - timezone in IANA format 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.
6.1 - "from" (string
)
- start datetime 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
_linksobject"_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

300 (report job execution result location)

Headers

ParameterTypeDescriptionRequired
LocationstringThe job results location.
Default:
/data/reports/{type}/files/{id}
no

Body

ParameterTypeDescriptionRequired
jobobject"job" subdivides into:

1 - "id" (string) - the job ID.

2 - "name" (string) - report's name.

3 - "name" (string) - report's name.

4 - "timezone" (string) - timezone in IANA format which the report timespan (from and to) will be applied.

5 - "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.
6.1 - "from" (string
)
- start datetime 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"_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 access), 403 (forbidden access), 404 (report job not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

🚧

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.

Language
Authorization
Header
Click Try It! to start a request and see the response here!