Get Monitor Placement Summary
curl --request GET \
--url https://api.campaigncleaner.com/v1/monitor_get_summaryimport requests
url = "https://api.campaigncleaner.com/v1/monitor_get_summary"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.campaigncleaner.com/v1/monitor_get_summary', 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://api.campaigncleaner.com/v1/monitor_get_summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.campaigncleaner.com/v1/monitor_get_summary"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.campaigncleaner.com/v1/monitor_get_summary")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.campaigncleaner.com/v1/monitor_get_summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"days": 30,
"domain_id": null,
"overall": {
"total": 21,
"inbox": 12,
"tabs": 0,
"spam": 9,
"other": 0,
"inbox_rate": 57.1,
"spam_rate": 42.9
},
"providers": [
{
"provider": "Outlook.com / Hotmail",
"provider_key": "outlook.com",
"total": 12,
"inbox": 7,
"tabs": 0,
"spam": 5,
"other": 0,
"inbox_rate": 58.3,
"spam_rate": 41.7
}
],
"note": "inbox_rate counts Gmail tabs (Promotions, Updates ...) as inbox, like the dashboard."
}Inbox Placement Monitor
Get Monitor Placement Summary
The monitor_get_summary API returns the inbox and spam rate overall and per provider. inbox_rate counts Gmail tabs (Promotions, Updates, …) as inbox, like the dashboard. Rates are null when there is no mail.
Header:
X-CC-API-Key: Your API Key
Parameters (all optional):
- days: 1 to 365, default 30 (older days come from daily totals).
- domain_id: Only this monitored domain.
Response:
- overall and each entry in providers: total, inbox, tabs, spam, other, inbox_rate, spam_rate (providers also have provider and provider_key).
GET
/
v1
/
monitor_get_summary
Get Monitor Placement Summary
curl --request GET \
--url https://api.campaigncleaner.com/v1/monitor_get_summaryimport requests
url = "https://api.campaigncleaner.com/v1/monitor_get_summary"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.campaigncleaner.com/v1/monitor_get_summary', 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://api.campaigncleaner.com/v1/monitor_get_summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.campaigncleaner.com/v1/monitor_get_summary"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.campaigncleaner.com/v1/monitor_get_summary")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.campaigncleaner.com/v1/monitor_get_summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"days": 30,
"domain_id": null,
"overall": {
"total": 21,
"inbox": 12,
"tabs": 0,
"spam": 9,
"other": 0,
"inbox_rate": 57.1,
"spam_rate": 42.9
},
"providers": [
{
"provider": "Outlook.com / Hotmail",
"provider_key": "outlook.com",
"total": 12,
"inbox": 7,
"tabs": 0,
"spam": 5,
"other": 0,
"inbox_rate": 58.3,
"spam_rate": 41.7
}
],
"note": "inbox_rate counts Gmail tabs (Promotions, Updates ...) as inbox, like the dashboard."
}
