curl --request GET \
--url https://api.chatsailer.com/v1/campaigns/{campaign_id}/stats \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.chatsailer.com/v1/campaigns/{campaign_id}/stats"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.chatsailer.com/v1/campaigns/{campaign_id}/stats', 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://api.chatsailer.com/v1/campaigns/{campaign_id}/stats",
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://api.chatsailer.com/v1/campaigns/{campaign_id}/stats"
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://api.chatsailer.com/v1/campaigns/{campaign_id}/stats")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chatsailer.com/v1/campaigns/{campaign_id}/stats")
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{
"campaign_id": "camp_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"contacted": 1,
"converted": 1,
"enrolled": 1,
"not_contacted": [
{
"count": 1,
"reason": "meta_account"
}
],
"replied": 1,
"replied_automated": 1,
"window_end": "2023-11-07T05:31:56Z",
"window_start": "2023-11-07T05:31:56Z",
"conversion_rate": 1,
"object": "campaign_stats",
"reply_rate": 1
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}Retrieve campaign stats
Funnel counts, reply and conversion rates, and why participants were not contacted, for one time window. The window defaults to the 30 days ending now.
All counts come from one consistent definition, so replied never exceeds contacted. Sailer’s campaign dashboard also shows a stricter response rate, which counts only a contact’s first reply after the campaign message; expect that figure to be somewhat lower than reply_rate here.
curl --request GET \
--url https://api.chatsailer.com/v1/campaigns/{campaign_id}/stats \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.chatsailer.com/v1/campaigns/{campaign_id}/stats"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.chatsailer.com/v1/campaigns/{campaign_id}/stats', 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://api.chatsailer.com/v1/campaigns/{campaign_id}/stats",
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://api.chatsailer.com/v1/campaigns/{campaign_id}/stats"
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://api.chatsailer.com/v1/campaigns/{campaign_id}/stats")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chatsailer.com/v1/campaigns/{campaign_id}/stats")
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{
"campaign_id": "camp_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4",
"contacted": 1,
"converted": 1,
"enrolled": 1,
"not_contacted": [
{
"count": 1,
"reason": "meta_account"
}
],
"replied": 1,
"replied_automated": 1,
"window_end": "2023-11-07T05:31:56Z",
"window_start": "2023-11-07T05:31:56Z",
"conversion_rate": 1,
"object": "campaign_stats",
"reply_rate": 1
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "invalid_request_error",
"detail": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"documentation_url": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}Authorizations
A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.
Path Parameters
Unique identifier for a campaign.
^camp_[0-9a-f]{32}$"camp_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Query Parameters
Start of the window, inclusive. Needs a timezone offset.
End of the window, exclusive. Defaults to now.
Response
Successful Response
How a campaign performed over a time window.
Counts cover participants the campaign messaged in
[window_start, window_end) — except enrolled, which covers the whole
campaign, and not_contacted, which counts participants whose status last
changed in the window. Rates are fractions: 0.25 means 25%.
Unique identifier for a campaign.
^camp_[0-9a-f]{32}$"camp_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Participants the campaign messaged successfully.
x >= 0Distinct contacts the campaign messaged who were marked as won afterwards.
x >= 0Participants ever added to the campaign, in any status.
x >= 0Every reason, in a fixed order, including those with zero.
Show child attributes
Show child attributes
Contacted participants who replied. Replies that look automated (away messages, bots) are not counted here.
x >= 0Contacted participants whose reply looks automated.
x >= 0converted / contacted. Null when nobody was contacted.
x >= 0"campaign_stats"replied / contacted. Null when nobody was contacted.
x >= 0