Get a placement test
curl --request GET \
--url https://cloudapi.mailercloud.com/v2/placement/tests/{test_id} \
--header 'Authorization: <api-key>'import requests
url = "https://cloudapi.mailercloud.com/v2/placement/tests/{test_id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://cloudapi.mailercloud.com/v2/placement/tests/{test_id}', 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://cloudapi.mailercloud.com/v2/placement/tests/{test_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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://cloudapi.mailercloud.com/v2/placement/tests/{test_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"test_id": "<string>",
"campaign_id": "<string>",
"status": "running",
"started_at": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"seeds": {
"total": 123,
"reported": 123,
"pending": 123,
"missing": 123
},
"totals": {
"inbox_pct": 123,
"spam_pct": 123,
"tab_pct": 123,
"missing_pct": 123,
"pending_pct": 123
},
"by_provider": [
{
"provider_id": "<string>",
"group_id": "<string>",
"country_code": "<string>",
"name": "<string>",
"seeds": 123,
"inbox": 123,
"spam": 123,
"tab": 123,
"pending": 123,
"missing": 123,
"inbox_pct": 123,
"spam_pct": 123,
"missing_pct": 123,
"median_delay_s": 123,
"gmail_tabs": {}
}
],
"by_market": [
{
"provider_id": "<string>",
"group_id": "<string>",
"country_code": "<string>",
"name": "<string>",
"seeds": 123,
"inbox": 123,
"spam": 123,
"tab": 123,
"pending": 123,
"missing": 123,
"inbox_pct": 123,
"spam_pct": 123,
"missing_pct": 123,
"median_delay_s": 123
}
],
"gmail_tabs": {},
"auth": {
"spf": "<string>",
"dkim": "<string>",
"dmarc": "<string>",
"bimi": "<string>"
},
"identity": {
"sender_domain": "<string>",
"sender_ip": "<string>",
"return_path": "<string>",
"rdns": "<string>",
"helo": "<string>",
"sender_score": 123
},
"filters": [
{
"name": "<string>",
"received": true,
"verdict": "<string>",
"score": 123,
"threshold": 123
}
],
"rules": [
{
"filter": "<string>",
"tag": "<string>",
"description": "<string>",
"score": 123
}
],
"blocklists": {
"ips": [
{
"ip": "<string>",
"rdns": "<string>",
"listed": 123,
"lists": [
"<string>"
],
"shared_pool": true
}
],
"domains": [
{
"domain": "<string>",
"listed": 123,
"lists": [
"<string>"
]
}
]
},
"content": {
"message_bytes": 123,
"html_bytes": 123,
"plain_bytes": 123,
"images": [
{
"url": "<string>",
"status_code": 123,
"bytes": 123,
"response_ms": 123,
"redirects": 123,
"broken": true
}
],
"links": [
{
"url": "<string>",
"location": "<string>",
"text": "<string>",
"status_code": 123,
"redirects": 123,
"response_ms": 123,
"tracked": true,
"unsubscribe": true,
"broken": true
}
]
},
"issues": [
{
"code": "<string>",
"severity": "blocking",
"title": "<string>",
"impact": "<string>",
"action": "<string>",
"cta": {
"label": "<string>",
"kind": "edit_email",
"url": "<string>"
},
"affected_seeds": 123
}
],
"severity_counts": {
"blocking": 123,
"worth_fixing": 123,
"passing": 123
},
"eta_at": "2023-11-07T05:31:56Z",
"eta_seconds": 123
}
}{
"error": "<string>",
"code": "CAMPAIGN_NOT_FOUND"
}{
"error": "<string>",
"code": "PLACEMENT_UNAVAILABLE"
}Get a placement test
Full result of one placement test: placement per provider and market, Gmail tabs, authentication, spam-filter verdicts, blocklists, content checks and a list of issues with fixes. While status is running, the numbers fill in as seeds report.
GET
/
v2
/
placement
/
tests
/
{test_id}
Get a placement test
curl --request GET \
--url https://cloudapi.mailercloud.com/v2/placement/tests/{test_id} \
--header 'Authorization: <api-key>'import requests
url = "https://cloudapi.mailercloud.com/v2/placement/tests/{test_id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://cloudapi.mailercloud.com/v2/placement/tests/{test_id}', 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://cloudapi.mailercloud.com/v2/placement/tests/{test_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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://cloudapi.mailercloud.com/v2/placement/tests/{test_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"test_id": "<string>",
"campaign_id": "<string>",
"status": "running",
"started_at": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"seeds": {
"total": 123,
"reported": 123,
"pending": 123,
"missing": 123
},
"totals": {
"inbox_pct": 123,
"spam_pct": 123,
"tab_pct": 123,
"missing_pct": 123,
"pending_pct": 123
},
"by_provider": [
{
"provider_id": "<string>",
"group_id": "<string>",
"country_code": "<string>",
"name": "<string>",
"seeds": 123,
"inbox": 123,
"spam": 123,
"tab": 123,
"pending": 123,
"missing": 123,
"inbox_pct": 123,
"spam_pct": 123,
"missing_pct": 123,
"median_delay_s": 123,
"gmail_tabs": {}
}
],
"by_market": [
{
"provider_id": "<string>",
"group_id": "<string>",
"country_code": "<string>",
"name": "<string>",
"seeds": 123,
"inbox": 123,
"spam": 123,
"tab": 123,
"pending": 123,
"missing": 123,
"inbox_pct": 123,
"spam_pct": 123,
"missing_pct": 123,
"median_delay_s": 123
}
],
"gmail_tabs": {},
"auth": {
"spf": "<string>",
"dkim": "<string>",
"dmarc": "<string>",
"bimi": "<string>"
},
"identity": {
"sender_domain": "<string>",
"sender_ip": "<string>",
"return_path": "<string>",
"rdns": "<string>",
"helo": "<string>",
"sender_score": 123
},
"filters": [
{
"name": "<string>",
"received": true,
"verdict": "<string>",
"score": 123,
"threshold": 123
}
],
"rules": [
{
"filter": "<string>",
"tag": "<string>",
"description": "<string>",
"score": 123
}
],
"blocklists": {
"ips": [
{
"ip": "<string>",
"rdns": "<string>",
"listed": 123,
"lists": [
"<string>"
],
"shared_pool": true
}
],
"domains": [
{
"domain": "<string>",
"listed": 123,
"lists": [
"<string>"
]
}
]
},
"content": {
"message_bytes": 123,
"html_bytes": 123,
"plain_bytes": 123,
"images": [
{
"url": "<string>",
"status_code": 123,
"bytes": 123,
"response_ms": 123,
"redirects": 123,
"broken": true
}
],
"links": [
{
"url": "<string>",
"location": "<string>",
"text": "<string>",
"status_code": 123,
"redirects": 123,
"response_ms": 123,
"tracked": true,
"unsubscribe": true,
"broken": true
}
]
},
"issues": [
{
"code": "<string>",
"severity": "blocking",
"title": "<string>",
"impact": "<string>",
"action": "<string>",
"cta": {
"label": "<string>",
"kind": "edit_email",
"url": "<string>"
},
"affected_seeds": 123
}
],
"severity_counts": {
"blocking": 123,
"worth_fixing": 123,
"passing": 123
},
"eta_at": "2023-11-07T05:31:56Z",
"eta_seconds": 123
}
}{
"error": "<string>",
"code": "CAMPAIGN_NOT_FOUND"
}{
"error": "<string>",
"code": "PLACEMENT_UNAVAILABLE"
}