Explore API
Overview
The Explore API, a Talkdesk Explore™ solution, is an asynchronous API that allows extracting historical reports' data.
You can, after pulling the data into your systems, incorporate this granular data into any analytics system. The Explore API allows getting valuable trends and insights regarding the performance of your company by correlating Talkdesk data with data from other systems.
Use Case
As a real life example, consider the scenario where the leadership team of a company has a key metrics dashboard, with information about the company's Financials, Products, HR, Marketing and also Customer Experience. You can retrieve Talkdesk Data via Explore API, store it in your analytical system and embed key customer metrics in the leadership dashboard.
Usage
The Explore API enables a client to request a data report and download it when it is ready.
The data obtained via Explore API has a five-minute delay to real-time.
Requirement
Transport Layer Security 1.2 (TLS) is the minimum version of the TLS protocol allowed for use on the Explore API endpoints.
Data Report Use Cases
-
Execute a report - send a request to create a report and receive the report ID to use in the following requests.
-
Check a report status - this request will redirect to the next request if the executing operation is complete and if it is allowed by the customer's app.
-
Download the report file - download the report file if it is ready.
-
Delete a report - mark the report as deleted and remove the report file.
API Availability
Explore API has been in General Availability since July 2021.
Troubleshooting
If you have questions or technical issues, please open a ticket using this form.
Updated about 1 year ago