Get CSAT report
Customer ratings per conversation with the agent, the stars and the comment.
GET https://cotlet.dev/api/v1/freshchat/csat-report
read
Returns the rows of Reports > Customer Satisfaction for a date range: customer name, the agent who handled the conversation, the rating, the customer's comment if there is one and the conversation_id. The survey uses five stars. Freshchat limits Reports to Account Owner and Admin roles, so other accounts cannot call it.
Parameters
| Name | Type | Description |
|---|---|---|
| from date | date | First day of the range. |
| to date | date | Last day of the range. |
| agent_id string | string | Only ratings for this agent, from list_agents. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/freshchat/csat-report \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("freshchat", "get_csat_report")const result = await cotlet.call('freshchat', 'get_csat_report');cotlet call freshchat get_csat_reportExample response
{
"ratings": [
{
"conversation_id": "b3d9f1a2-6c4e-4a8b-95d7-2e1f0c8a7b64",
"customer": "Lena Ortiz",
"agent": "Dana Reed",
"stars": 5,
"comment": "Quick and clear."
},
{
"conversation_id": "5a9c3e71-2d4b-4f08-b6a1-8e0d7c2f9b13",
"customer": "Sam Okafor",
"agent": "Marcus Hale",
"stars": 2,
"comment": "Had to explain twice."
}
],
"next_cursor": null
}