Track Important Events with Freshchat's Extract APIs
You can get more out of Freshchat using Extract APIs. Apart from the default In-product Reports, you can download reports for various other key metrics and your support SLAs within minutes in the form of customized raw reports using Freshchat Extract APIs
Types of Raw Reports
There are 12 different raw reports that you can download with Extract API,
Conversation Agent Assigned
Conversation Group Assigned
First Response Time
Conversation Resolution Label
Agent Intelliassign Activity
How to Download Raw Reports using Extract API
Step 1: Accessing the API Endpoint
Replace your domain name in the Endpoint API
If the endpoint is, https://mercasto.freshchat.com/v2/reports/raw/, then ‘Mercasto.freshchat.com’ is the domain name.
Step 2: API Payload
You must pass the Bearer token (API Token) in the header.
To know about how to get your API Token, Click here
This is the payload to be used for the Get request. For example, to get the conversation created between 12.00 AM to 11.59 PM UTC, the payload will be
Event name to be used in the payload
To process the get request, you’ll have to update the Job ID in your Endpoint API.
In this example, “dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927” is the job ID and endpoint API will be https://mercasto.freshchat.com/v2/reports/raw/dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927
After your GET request is processed, you can download your report from the URL from the code that is returned.
"interval": "2020-09-14 00:01:00.0 2020-09-14 23:59:00.0",
Important Points to Note:
Raw Reports can be downloaded in CSV format only.
The time zone used in the payload should be UTC.
It might take up to an hour for a report to be generated.
Only one POST request can be processed per minute.