Campaigns
Campaign analytics
Returns detailed campaign analytics including:
- Overall campaign stats (sent, opened, clicked, bounced, replied, unsubscribed)
- Step-by-step analytics with A/B variant breakdown
- Lead status breakdown (active, completed, bounced, etc.)
- Total replied count
curl -X GET "https://api.sendkit.ai/v1/campaigns/example_string/analytics" \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api.sendkit.ai/v1/campaigns/example_string/analytics"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.sendkit.ai/v1/campaigns/example_string/analytics", {
method: "GET",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.sendkit.ai/v1/campaigns/example_string/analytics", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.sendkit.ai/v1/campaigns/example_string/analytics')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"campaign": {
"id": "665a1b2c3d4e5f6a7b8c9d0e",
"name": "Q1 Outreach Campaign",
"status": "active",
"startedAt": "2025-06-15T09:00:00.000Z"
},
"stats": {
"sent": 150,
"delivered": 145,
"opened": 72,
"clicked": 18,
"replied": 12,
"bounced": 5,
"unsubscribed": 2
},
"stepAnalytics": [
{
"_id": {
"sequenceStep": 0,
"variant": null
},
"sent": 100,
"opened": 50,
"clicked": 12,
"bounced": 3
},
{
"_id": {
"sequenceStep": 2,
"variant": null
},
"sent": 50,
"opened": 22,
"clicked": 6,
"bounced": 2
}
],
"statusBreakdown": {
"active": 350,
"completed": 100,
"bounced": 5,
"unsubscribed": 2,
"replied": 12,
"removed": 31
},
"totalReplied": 12
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Campaign not found"
}
}
GET
/v1/campaigns/{id}/analyticsGET
API Key (header: X-Api-Key)
X-Api-Keystring
RequiredPlatform API key (sk_user_...) or Workspace API key (sk_...)
Platform API key (sk_user_...) or Workspace API key (sk_...)
path
idstring
RequiredResource ID
Request Preview
Response
Response will appear here after sending the request
Authentication
header
X-Api-Keystring
RequiredAPI Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
header
Authorizationstring
RequiredBearer token. API key as Bearer token
Path Parameters
idstring
RequiredResource ID
Responses
successboolean
dataobject
Was this page helpful?
Last updated today
Built with Documentation.AI