Analytics
Workspace analytics overview
Returns aggregate email stats across all campaigns in the workspace. Includes totals for sent, opened, clicked, bounced, and replied emails, plus campaign counts and calculated rates (as percentages with 1 decimal).
curl -X GET "https://api.sendkit.ai/v1/analytics/overview" \
-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/analytics/overview"
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/analytics/overview", {
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/analytics/overview", 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/analytics/overview')
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": {
"totalSent": 12500,
"totalOpened": 5625,
"totalClicked": 1250,
"totalBounced": 375,
"totalReplied": 625,
"totalCampaigns": 8,
"activeCampaigns": 3,
"rates": {
"open": "45.0",
"click": "10.0",
"reply": "5.0",
"bounce": "3.0"
}
}
}
{
"success": true,
"data": {
"totalSent": 0,
"totalOpened": 0,
"totalReplied": 0,
"totalBounced": 0,
"totalCampaigns": 0,
"activeCampaigns": 0
}
}
GET
/v1/analytics/overview
GET
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_...)
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
Responses
successboolean
dataobject
Was this page helpful?
Last updated today
Built with Documentation.AI