Checking a Report Job Status

❗️

The Reporting API has been replaced by the Explore API. Talkdesk strongly encourages the transition to the Explore API. You may still use the Reporting API, but please note:

  • Talkdesk will only provide support (no SLA for bug fixing or outage recovery) until June 1, 2022.
  • The Reporting API endpoint will stop responding to requests on December 1, 2022.

Request

Make a GETrequest to /reports/<report_type>/jobs/{id}

Sample Request

curl https://api.talkdeskapp.com/reports/calls/jobs/{id} \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-X GET

📘

Job Status URL

The job ID can be retrieved, as well as the URL to check on its status, by using the response of the initial job request call.

Sample Response

If the report job has yet to be processed, the endpoint will return a 200 response.

{
  "id": "57add63204c799583700028e",
  "status": "processing",
  "timespan": {
    "from": "2016-07-29 00:00:00 UTC",
    "to": "2016-07-29 23:59:59 UTC"
  },
  "_links": {
    "self": {
      "href": "https://api.talkdeskdev.com/reports/calls/jobs/57add63204c799583700028e"
    },
    "files": {
      "href": "https://api.talkdeskdev.com/reports/calls/files/57add63204c799583700028e"
    }
  }
}

Once the report job is complete, the endpoint will return a 303 response, redirecting to the location of the report resource file. The location of the file will be provided in the location HTTP header:

https://api.talkdeskdev.com/reports/calls/files/57add63204c799583700028e

The response body remains unchanged, except for the job status field getting updated to done.

{
  "id": "57add63204c799583700028e",
  "status": "done",
  "timespan": {
    "from": "2016-07-29 00:00:00 UTC",
    "to": "2016-07-29 23:59:59 UTC"
  },
  "_links": {
    "self": {
      "href": "https://api.talkdeskdev.com/reports/calls/jobs/57add63204c799583700028e"
    },
    "files": {
      "href": "https://api.talkdeskdev.com/reports/calls/files/57add63204c799583700028e"
    }
  }
}

Did this page help you?