curl -X GET "https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/runs/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b/compare/b7d2e6f1-4a38-4c19-9e05-6f8a1b2c3d4e?api_key=YOUR_KEY"
import requests
API_KEY = "YOUR_API_KEY"
response = requests.get(
"https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/runs/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b/compare/b7d2e6f1-4a38-4c19-9e05-6f8a1b2c3d4e",
params={"api_key": API_KEY}
)
print(response.status_code)
print(response.json())
const API_KEY = 'YOUR_API_KEY';
const response = await fetch(
`https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/runs/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b/compare/b7d2e6f1-4a38-4c19-9e05-6f8a1b2c3d4e?api_key=${API_KEY}`,
{
method: 'GET'
}
);
console.log(await response.json());
{
"a": { "ready": true, "score": 66, "band": "fair" },
"b": { "ready": true, "score": 72, "band": "fair" },
"delta": { "score": 6, "inboxRate": 0.125, "spamRate": -0.125 }
}
(reports shortened)
{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API Key"
}
}
Smart Delivery v2 (Deliverability Test)
Compare Two Runs
Compare the reports of two runs
GET
/
api
/
v1
/
smart-delivery
/
runs
/
{id}
/
compare
/
{otherRunId}
curl -X GET "https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/runs/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b/compare/b7d2e6f1-4a38-4c19-9e05-6f8a1b2c3d4e?api_key=YOUR_KEY"
import requests
API_KEY = "YOUR_API_KEY"
response = requests.get(
"https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/runs/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b/compare/b7d2e6f1-4a38-4c19-9e05-6f8a1b2c3d4e",
params={"api_key": API_KEY}
)
print(response.status_code)
print(response.json())
const API_KEY = 'YOUR_API_KEY';
const response = await fetch(
`https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/runs/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b/compare/b7d2e6f1-4a38-4c19-9e05-6f8a1b2c3d4e?api_key=${API_KEY}`,
{
method: 'GET'
}
);
console.log(await response.json());
{
"a": { "ready": true, "score": 66, "band": "fair" },
"b": { "ready": true, "score": 72, "band": "fair" },
"delta": { "score": 6, "inboxRate": 0.125, "spamRate": -0.125 }
}
(reports shortened)
{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API Key"
}
}
Smart Delivery v2 (Deliverability Test) API: the deliverability (inbox placement) test that sends your campaign email to seed inboxes and reports where it landed. Contact support@smartlead.ai for access.
Overview
Returns both run reports and the difference between them. Each report is the body of Get Run Report.Path Parameters
Query Parameters
curl -X GET "https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/runs/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b/compare/b7d2e6f1-4a38-4c19-9e05-6f8a1b2c3d4e?api_key=YOUR_KEY"
import requests
API_KEY = "YOUR_API_KEY"
response = requests.get(
"https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/runs/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b/compare/b7d2e6f1-4a38-4c19-9e05-6f8a1b2c3d4e",
params={"api_key": API_KEY}
)
print(response.status_code)
print(response.json())
const API_KEY = 'YOUR_API_KEY';
const response = await fetch(
`https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/runs/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b/compare/b7d2e6f1-4a38-4c19-9e05-6f8a1b2c3d4e?api_key=${API_KEY}`,
{
method: 'GET'
}
);
console.log(await response.json());
Response Fields
Change from
a to b: score, inboxRate and spamRate. null when either report is not readyResponse Codes
Client (agency) API keys are not allowed (
CLIENT_NOT_ALLOWED), or your plan does not include API access (API_ACCESS_RESTRICTED)Too many requests for this API key. Wait the number of seconds in the
Retry-After header (RATE_LIMITED){
"a": { "ready": true, "score": 66, "band": "fair" },
"b": { "ready": true, "score": 72, "band": "fair" },
"delta": { "score": 6, "inboxRate": 0.125, "spamRate": -0.125 }
}
(reports shortened)
{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API Key"
}
}
