curl --request GET \
--url https://www.chatbase.co/api/v2/agents/{agentId}/analytics \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.chatbase.co/api/v2/agents/{agentId}/analytics"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.chatbase.co/api/v2/agents/{agentId}/analytics', 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://www.chatbase.co/api/v2/agents/{agentId}/analytics",
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://www.chatbase.co/api/v2/agents/{agentId}/analytics"
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://www.chatbase.co/api/v2/agents/{agentId}/analytics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.chatbase.co/api/v2/agents/{agentId}/analytics")
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{
"buckets": [
{
"start": 123,
"end": 123,
"conversations": 123,
"messages": 123,
"positive": 123,
"neutral": 123,
"negative": 123,
"escalated": 123,
"thumbsUp": 123,
"thumbsDown": 123,
"ticketsByStatus": [
{
"value": "new",
"count": 123
}
],
"procedures": [
{
"value": "<string>",
"count": 123
}
],
"tools": [
{
"value": "<string>",
"count": 123
}
],
"actionTypes": [
{
"value": "<string>",
"count": 123
}
]
}
],
"sources": [
{
"value": "<string>",
"count": 123
}
],
"toolsUsed": [
{
"value": "<string>",
"count": 123
}
],
"countries": [
{
"value": "<string>",
"count": 123
}
],
"confidence": [
123
],
"conversationsByHour": [
123
],
"creditsByDay": [
{
"date": "<string>",
"credits": 123
}
]
}Get agent analytics
Returns an agent’s activity over a date range split into 7 equal buckets: conversations, messages, sentiment, escalations, ratings, help desk tickets, procedure runs, tool calls and action types per bucket. For the whole range it adds conversation counts by source, action, country, answer confidence and hour of day, plus credits per day. Conversations count by last activity, and the range must fall inside the searchable window (since the 1st of the month 12 months ago, UTC).
curl --request GET \
--url https://www.chatbase.co/api/v2/agents/{agentId}/analytics \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.chatbase.co/api/v2/agents/{agentId}/analytics"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.chatbase.co/api/v2/agents/{agentId}/analytics', 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://www.chatbase.co/api/v2/agents/{agentId}/analytics",
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://www.chatbase.co/api/v2/agents/{agentId}/analytics"
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://www.chatbase.co/api/v2/agents/{agentId}/analytics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.chatbase.co/api/v2/agents/{agentId}/analytics")
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{
"buckets": [
{
"start": 123,
"end": 123,
"conversations": 123,
"messages": 123,
"positive": 123,
"neutral": 123,
"negative": 123,
"escalated": 123,
"thumbsUp": 123,
"thumbsDown": 123,
"ticketsByStatus": [
{
"value": "new",
"count": 123
}
],
"procedures": [
{
"value": "<string>",
"count": 123
}
],
"tools": [
{
"value": "<string>",
"count": 123
}
],
"actionTypes": [
{
"value": "<string>",
"count": 123
}
]
}
],
"sources": [
{
"value": "<string>",
"count": 123
}
],
"toolsUsed": [
{
"value": "<string>",
"count": 123
}
],
"countries": [
{
"value": "<string>",
"count": 123
}
],
"confidence": [
123
],
"conversationsByHour": [
123
],
"creditsByDay": [
{
"date": "<string>",
"credits": 123
}
]
}Authorizations
API key from your account settings
Path Parameters
The agent ID
1"5QHA6VB-DIAbBhxwqxfdi"
Query Parameters
Range start (YYYY-MM-DD or ISO 8601). Defaults to 7 days before endDate.
Range end (YYYY-MM-DD, inclusive, or ISO 8601). Defaults to now; a later end is capped to now.
IANA time zone for conversationsByHour, e.g. America/New_York. Defaults to UTC.
"UTC"
Response
Agent analytics for the range
The range split into 7 equal buckets, oldest first
Show child attributes
Show child attributes
Conversations in the range by source
Show child attributes
Show child attributes
Conversations in the range by tool used
Show child attributes
Show child attributes
Conversations in the range by country code
Show child attributes
Show child attributes
Conversations in the range by their lowest answer confidence score, in 10 bins of 0.1: index 0 is 0–0.1, index 9 is 0.9–1. A conversation with no scored answers counts as 1.
Conversations in the range by the hour they started in timeZone: 24 counts, index 0 is 00:00–01:00. Counts come from whole UTC hours, so zones with a 30- or 45-minute offset are approximate.
Credits the agent used per UTC day that overlaps the range. Days with no usage are omitted.
Show child attributes
Show child attributes