Skip to main content
GET
/
api
/
v2
/
analytics
/
csat
Get CSAT analytics
curl --request GET \
  --url https://app.livechatai.com/api/v2/analytics/csat \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://app.livechatai.com/api/v2/analytics/csat"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.livechatai.com/api/v2/analytics/csat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.livechatai.com/api/v2/analytics/csat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://app.livechatai.com/api/v2/analytics/csat"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.livechatai.com/api/v2/analytics/csat")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.livechatai.com/api/v2/analytics/csat")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "data": {
    "currentPeriod": {
      "averageScore": 4.2,
      "totalResponses": 45,
      "scores": [
        {
          "id": "csat_abc123",
          "score": 5,
          "comment": "Great support experience!",
          "email": "customer@example.com",
          "name": "John Doe",
          "triggerReason": "AFTER_RESOLUTION",
          "createdAt": "2024-01-15T10:30:00.000Z"
        }
      ]
    },
    "previousPeriod": {
      "averageScore": 3.8,
      "totalResponses": 38,
      "scores": [
        {}
      ]
    },
    "changes": {
      "averageScore": 10.5,
      "totalResponses": 18.4
    },
    "metadata": {
      "totalItemCount": 45,
      "totalPageCount": 5,
      "currentPage": 1,
      "prev": null,
      "next": 2,
      "pageSize": 10
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

agentId
string
required

The ID of the agent/chatbot

Example:

"clx1234567890abcdef"

startDate
string<date>
required

Start date for analytics (ISO 8601 format)

Example:

"2024-01-01"

endDate
string<date>
required

End date for analytics (ISO 8601 format)

Example:

"2024-01-31"

timezone
string

Timezone for date calculations (defaults to system timezone)

Example:

"America/New_York"

page
integer
default:1

Page number for pagination (starts at 1)

Required range: x >= 1
Example:

1

pageSize
integer
default:10

Number of items per page (max 100)

Required range: 1 <= x <= 100
Example:

10

Response

Successfully retrieved CSAT analytics data

status
string
Example:

"success"

data
object