Workspace warmup stats
Returns aggregated warmup metrics across all warming mailboxes in the workspace, plus per-mailbox summaries with inbox/spam rates and health scores.
Health score formula: inboxRate * 0.5 + (100 - spamRate) * 0.3 + openRate * 0.2 (capped at 100).
curl -X GET "https://api.sendkit.ai/v1/warmup/stats?days=42&search=example_string&page=25&limit=42&cursor=example_string" \
-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/warmup/stats?days=42&search=example_string&page=25&limit=42&cursor=example_string"
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/warmup/stats?days=42&search=example_string&page=25&limit=42&cursor=example_string", {
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/warmup/stats?days=42&search=example_string&page=25&limit=42&cursor=example_string", 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/warmup/stats?days=42&search=example_string&page=25&limit=42&cursor=example_string')
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": {
"summary": {
"totalSent": 450,
"inbox": 380,
"spam": 40,
"promotions": 20,
"replied": 90,
"opened": 350,
"inboxRate": 84,
"spamRate": 9,
"warmingMailboxes": 3,
"days": 7
},
"mailboxes": [
{
"id": "664a1b2c3d4e5f6a7b8c9d03",
"email": "sales@mycompany.com",
"displayName": "Sales Team",
"warmup": {
"status": "in_progress",
"currentDay": 14,
"currentVolume": 25,
"config": {},
"metrics": {},
"startedAt": "2024-05-18T10:00:00.000Z"
},
"stats": {
"totalSent": 175,
"inbox": 155,
"spam": 12,
"promotions": 5,
"replied": 40,
"opened": 145,
"inboxRate": 89,
"spamRate": 7,
"healthScore": 88
}
},
{
"id": "664a1b2c3d4e5f6a7b8c9d04",
"email": "outreach@mycompany.com",
"displayName": "Outreach",
"warmup": {
"status": "in_progress",
"currentDay": 7,
"currentVolume": 15,
"config": {},
"metrics": {},
"startedAt": "2024-05-25T10:00:00.000Z"
},
"stats": {
"totalSent": 105,
"inbox": 85,
"spam": 15,
"promotions": 3,
"replied": 20,
"opened": 80,
"inboxRate": 81,
"spamRate": 14,
"healthScore": 76
}
}
]
},
"pagination": {
"total": 3,
"page": 1,
"limit": 20,
"pages": 1
}
}
/v1/warmup/stats
Platform API key (sk_user_...) or Workspace API key (sk_...)
Number of days to aggregate stats over (default 7, max 90)
Search by mailbox email or display name (case-insensitive)
Cursor ID for cursor-based pagination (use instead of page for large datasets)
Request Preview
Response
Response will appear here after sending the request
Authentication
API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
Bearer token. API key as Bearer token
Query Parameters
Number of days to aggregate stats over (default 7, max 90)
Search by mailbox email or display name (case-insensitive)
Cursor ID for cursor-based pagination (use instead of page for large datasets)
Responses
Last updated today
Built with Documentation.AI