Inspecting Previous Report Jobs

❗️

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.

Make a GETrequest to /reports/<report_type>/jobs

It is possible to inspect the recent history of report generation jobs by using the list jobs endpoint.

Optionally, pagination can be specified using page and per_page as query parameters.

Sample Request

curl https://api.talkdeskapp.com/reports/calls/jobs?per_page=3 \
-H 'Authorization: Bearer {ACESS_TOKEN}' \
-X GET

Sample Response

If the request is successful, you will receive a 200 response with this paginated list of recent report jobs.

{
  "_embedded": 
    "jobs": [
      {
        "id": "57a07d18108e4282ae0000d6",
        "status": "canceled",
        "timespan": {
          "from": "2010-01-01 22:13:12 UTC",
          "to": "2016-05-01 22:13:12 UTC"
        },
        "_links": {
          "self": {
            "href": "https://api.talkdeskdev.com/reports/calls/jobs/57a07d18108e4282ae0000d6"
          },
          "files": {
            "href": "https://api.talkdeskdev.com/reports/calls/files/57a07d18108e4282ae0000d6"
          }
        }
      },
      {
        "id": "57a07c5a108e4248c30000bd",
        "status": "canceled",
        "timespan": {
          "from": "2010-01-01 22:13:12 UTC",
          "to": "2016-05-01 22:13:12 UTC"
        },
        "_links": {
          "self": {
            "href": "https://api.talkdeskdev.com/reports/calls/jobs/57a07c5a108e4248c30000bd"
          },
          "files": {
            "href": "https://api.talkdeskdev.com/reports/calls/files/57a07c5a108e4248c30000bd"
          }
        }
      },
      {
        "id": "57a4d60ed3188a8bbc0004a2",
        "status": "canceled",
        "timespan": {
          "from": "2010-04-29 00:00:00 UTC",
          "to": "2016-07-29 00:00:00 UTC"
        },
        "_links": {
          "self": {
            "href": "https://api.talkdeskdev.com/reports/calls/jobs/57a4d60ed3188a8bbc0004a2"
          },
          "files": {
            "href": "https://api.talkdeskdev.com/reports/calls/files/57a4d60ed3188a8bbc0004a2"
          }
        }
      }
    ]
  },
  "total": 41,
  "page": 1,
  "per_page": 3,
  "_links": {
    "self": {
      "href": "https://api.talkdeskdev.com/reports/calls/jobs?page=1&per_page=3"
    },
    "page": {
      "templated": true,
      "href": "https://api.talkdeskdev.com/reports/calls/jobs{?page,per_page}"
    },
    "next": {
      "href": "https://api.talkdeskdev.com/reports/calls/jobs?page=2&per_page=3"
    }
  }
}

📘

Job Retention Policy

Report jobs will be available in Talkdesk for one month.


Did this page help you?