Get campaign analytics for organization
curl --request GET \
--url https://your-instance.example.com/api/campaigns/analytics \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/campaigns/analytics"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/campaigns/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://your-instance.example.com/api/campaigns/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://your-instance.example.com/api/campaigns/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://your-instance.example.com/api/campaigns/analytics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/campaigns/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{
"success": true,
"data": {
"totalCampaigns": 42,
"scheduledCount": 5,
"sentCount": 30,
"failedCount": 1,
"partialSuccessCount": 4,
"cancelledCount": 2,
"segmentedCount": 8,
"segmentedPercentage": "19.05%",
"totalMessages": 12450,
"sentMessages": 12380,
"scheduledMessages": 50,
"failedMessages": 20,
"overallSuccessRate": "99.4%"
}
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}Campaigns
Get campaign analytics for organization
Returns aggregate campaign analytics for the authenticated user organization: total campaigns, status breakdown (scheduled/sent/failed/partial/cancelled), segmented campaign counts, and per-message totals with overall success rate.
GET
/
api
/
campaigns
/
analytics
Get campaign analytics for organization
curl --request GET \
--url https://your-instance.example.com/api/campaigns/analytics \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/campaigns/analytics"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/campaigns/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://your-instance.example.com/api/campaigns/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://your-instance.example.com/api/campaigns/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://your-instance.example.com/api/campaigns/analytics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/campaigns/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{
"success": true,
"data": {
"totalCampaigns": 42,
"scheduledCount": 5,
"sentCount": 30,
"failedCount": 1,
"partialSuccessCount": 4,
"cancelledCount": 2,
"segmentedCount": 8,
"segmentedPercentage": "19.05%",
"totalMessages": 12450,
"sentMessages": 12380,
"scheduledMessages": 50,
"failedMessages": 20,
"overallSuccessRate": "99.4%"
}
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}⌘I