Metrics
Get deliverability advisor
Returns the current deliverability score and actionable recommendations for the authenticated project.
Requirements
- Permission:
emails:sendoremails:readormetrics:read. - HTTP rate limit: 120 requests per 60 seconds per API key.
GET
/
v1
/
metrics
/
advisor
Get deliverability advisor
curl --request GET \
--url https://api.signal.apollodeploy.com/v1/metrics/advisor \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.signal.apollodeploy.com/v1/metrics/advisor"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.signal.apollodeploy.com/v1/metrics/advisor', 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.signal.apollodeploy.com/v1/metrics/advisor",
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: Bearer <token>"
],
]);
$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.signal.apollodeploy.com/v1/metrics/advisor"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.signal.apollodeploy.com/v1/metrics/advisor")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.signal.apollodeploy.com/v1/metrics/advisor")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"generatedAt": "<string>",
"projectId": "<string>",
"recommendations": [
{
"code": "<string>",
"message": "<string>",
"severity": "<string>",
"title": "<string>",
"data": {
"accepted": 123,
"accepted24h": 123,
"adjustedOpenRate": 123,
"avgDailyAccepted7d": 123,
"bounceRate": 123,
"bounced": 123,
"complaintRate": 123,
"daysSinceLastSend": 123,
"delivered": 123,
"dmarcAccountedRate": 123,
"dmarcAlignedMessages": 123,
"dmarcAlignmentFailureRate7d": 123,
"dmarcCurrentPolicy": "<string>",
"dmarcDomain": "<string>",
"dmarcObservedMessages": 123,
"dmarcRecommendedPolicy": "<string>",
"dmarcReportingDays": 123,
"dmarcUnknownMessages": 123,
"dmarcUnknownSources": 123,
"humanOpenRate": 123,
"proxyOpens": 123,
"proxyRate": 123,
"reportedOpenRate": 123,
"totalOpens": 123,
"unsubRate": 123,
"unsubscribed": 123
}
}
],
"score": 123
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>",
"errors": [
{
"detail": "<string>",
"pointer": "<string>"
}
],
"instance": "<string>",
"requestId": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>",
"errors": [
{
"detail": "<string>",
"pointer": "<string>"
}
],
"instance": "<string>",
"requestId": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>",
"errors": [
{
"detail": "<string>",
"pointer": "<string>"
}
],
"instance": "<string>",
"requestId": "<string>"
}Authorizations
Project-bound Apollo Signal API key. Keys begin with ap_signal_ and must carry the permission shown on the operation.
Query Parameters
Required for session auth; ignored for API key auth.
Was this page helpful?
⌘I
Get deliverability advisor
curl --request GET \
--url https://api.signal.apollodeploy.com/v1/metrics/advisor \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.signal.apollodeploy.com/v1/metrics/advisor"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.signal.apollodeploy.com/v1/metrics/advisor', 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.signal.apollodeploy.com/v1/metrics/advisor",
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: Bearer <token>"
],
]);
$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.signal.apollodeploy.com/v1/metrics/advisor"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.signal.apollodeploy.com/v1/metrics/advisor")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.signal.apollodeploy.com/v1/metrics/advisor")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"generatedAt": "<string>",
"projectId": "<string>",
"recommendations": [
{
"code": "<string>",
"message": "<string>",
"severity": "<string>",
"title": "<string>",
"data": {
"accepted": 123,
"accepted24h": 123,
"adjustedOpenRate": 123,
"avgDailyAccepted7d": 123,
"bounceRate": 123,
"bounced": 123,
"complaintRate": 123,
"daysSinceLastSend": 123,
"delivered": 123,
"dmarcAccountedRate": 123,
"dmarcAlignedMessages": 123,
"dmarcAlignmentFailureRate7d": 123,
"dmarcCurrentPolicy": "<string>",
"dmarcDomain": "<string>",
"dmarcObservedMessages": 123,
"dmarcRecommendedPolicy": "<string>",
"dmarcReportingDays": 123,
"dmarcUnknownMessages": 123,
"dmarcUnknownSources": 123,
"humanOpenRate": 123,
"proxyOpens": 123,
"proxyRate": 123,
"reportedOpenRate": 123,
"totalOpens": 123,
"unsubRate": 123,
"unsubscribed": 123
}
}
],
"score": 123
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>",
"errors": [
{
"detail": "<string>",
"pointer": "<string>"
}
],
"instance": "<string>",
"requestId": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>",
"errors": [
{
"detail": "<string>",
"pointer": "<string>"
}
],
"instance": "<string>",
"requestId": "<string>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>",
"errors": [
{
"detail": "<string>",
"pointer": "<string>"
}
],
"instance": "<string>",
"requestId": "<string>"
}