curl --request GET \
--url https://core-service.prod.brudcast.com/api/v1/user/reports/deliverability \
--header 'X-API-Key: <api-key>'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/reports/deliverability"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://core-service.prod.brudcast.com/api/v1/user/reports/deliverability', 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://core-service.prod.brudcast.com/api/v1/user/reports/deliverability",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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://core-service.prod.brudcast.com/api/v1/user/reports/deliverability"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core-service.prod.brudcast.com/api/v1/user/reports/deliverability")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/reports/deliverability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"kpis": {
"inboxPlacementRate": 97.8,
"bounceRate": 0.4,
"complaintRate": 0.02,
"blacklistStatus": "listed",
"totalSent": 123,
"totalDelivered": 123,
"totalBounced": 123,
"totalUnconfirmed": 123,
"trends": {
"sent": {
"direction": "up",
"value": 12.5
},
"delivered": {
"direction": "up",
"value": 12.5
},
"opened": {
"direction": "up",
"value": 12.5
},
"clicked": {
"direction": "up",
"value": 12.5
},
"bounceRate": {
"direction": "up",
"value": 12.5
},
"complaintRate": {
"direction": "up",
"value": 12.5
}
}
},
"inboxPlacementTrend": [
{
"date": "2026-07-01T00:00:00.000Z",
"inboxRate": 123,
"sent": 123,
"delivered": 123
}
],
"bounceBreakdown": {
"hardBounced": 123,
"softBounced": 123,
"totalBounced": 123
},
"domainReputation": [
{
"domain": "mail.example.com",
"dkimEnabled": true,
"spfEnabled": true,
"dmarcEnabled": true,
"blacklistsListed": 123,
"blacklistsChecked": 123
}
],
"blacklistChecks": [
{
"domain": "mail.example.com",
"blacklist": "spamhaus",
"status": "listed",
"response": "<string>",
"checkedAt": "2023-11-07T05:31:56Z"
}
]
}
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "The payload is invalid",
"code": "E_VALIDATION_ERROR",
"errors": [
{
"field": "emailAddress",
"rule": "email",
"message": "The emailAddress field must be a valid email address"
}
]
}{
"success": false,
"message": "Too many requests",
"code": "E_TOO_MANY_REQUESTS",
"retryAfter": 60
}Get the deliverability report
Returns inbox placement, bounce and complaint rates with the send totals behind them, the daily placement trend, the bounce breakdown, per-domain reputation and the latest blacklist check per domain and blacklist. Inbox placement is approximated as delivered over sent, so a rate below 100 percent beside a zero bounce rate is explained by totalUnconfirmed, the mail still in flight. blacklistStatus is unknown until at least one check has run. The bounce breakdown is a period total, not a series. Requires the analytics:read scope.
curl --request GET \
--url https://core-service.prod.brudcast.com/api/v1/user/reports/deliverability \
--header 'X-API-Key: <api-key>'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/reports/deliverability"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://core-service.prod.brudcast.com/api/v1/user/reports/deliverability', 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://core-service.prod.brudcast.com/api/v1/user/reports/deliverability",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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://core-service.prod.brudcast.com/api/v1/user/reports/deliverability"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core-service.prod.brudcast.com/api/v1/user/reports/deliverability")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/reports/deliverability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"kpis": {
"inboxPlacementRate": 97.8,
"bounceRate": 0.4,
"complaintRate": 0.02,
"blacklistStatus": "listed",
"totalSent": 123,
"totalDelivered": 123,
"totalBounced": 123,
"totalUnconfirmed": 123,
"trends": {
"sent": {
"direction": "up",
"value": 12.5
},
"delivered": {
"direction": "up",
"value": 12.5
},
"opened": {
"direction": "up",
"value": 12.5
},
"clicked": {
"direction": "up",
"value": 12.5
},
"bounceRate": {
"direction": "up",
"value": 12.5
},
"complaintRate": {
"direction": "up",
"value": 12.5
}
}
},
"inboxPlacementTrend": [
{
"date": "2026-07-01T00:00:00.000Z",
"inboxRate": 123,
"sent": 123,
"delivered": 123
}
],
"bounceBreakdown": {
"hardBounced": 123,
"softBounced": 123,
"totalBounced": 123
},
"domainReputation": [
{
"domain": "mail.example.com",
"dkimEnabled": true,
"spfEnabled": true,
"dmarcEnabled": true,
"blacklistsListed": 123,
"blacklistsChecked": 123
}
],
"blacklistChecks": [
{
"domain": "mail.example.com",
"blacklist": "spamhaus",
"status": "listed",
"response": "<string>",
"checkedAt": "2023-11-07T05:31:56Z"
}
]
}
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "The payload is invalid",
"code": "E_VALIDATION_ERROR",
"errors": [
{
"field": "emailAddress",
"rule": "email",
"message": "The emailAddress field must be a valid email address"
}
]
}{
"success": false,
"message": "Too many requests",
"code": "E_TOO_MANY_REQUESTS",
"retryAfter": 60
}Authorizations
An organization API key, prefixed bk_live_. Takes precedence over Authorization when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint.
Headers
Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403.