Metrics
Get email read engagement
Returns read and scroll engagement analytics for one email. Values are present only when read-engagement tracking collected them.
Requirements
- Permission:
emails:sendoremails:readormetrics:read. - HTTP rate limit: 120 requests per 60 seconds per API key.
GET
/
v1
/
metrics
/
emails
/
{id}
/
engagement
Get email read engagement
curl --request GET \
--url https://api.signal.apollodeploy.com/v1/metrics/emails/{id}/engagement \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.signal.apollodeploy.com/v1/metrics/emails/{id}/engagement"
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/emails/{id}/engagement', 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/emails/{id}/engagement",
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/emails/{id}/engagement"
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/emails/{id}/engagement")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.signal.apollodeploy.com/v1/metrics/emails/{id}/engagement")
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{
"computedAt": "<string>",
"depth100Count": 123,
"depth25Count": 123,
"depth50Count": 123,
"depth75Count": 123,
"emailId": "<string>",
"readEngaged": true,
"shortEmail": true,
"subject": "<string>",
"depth100Rate": 123,
"depth25Rate": 123,
"depth50Rate": 123,
"depth75Rate": 123,
"deviceType": "<string>",
"mailClient": "<string>",
"maxDepthPct": 123,
"os": "<string>",
"readCategory": "<string>",
"readEngagedAt": "<string>",
"readTimeSeconds": 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>"
}{
"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.
Path Parameters
Email identifier.
Response
Request completed successfully.
Was this page helpful?
⌘I
Get email read engagement
curl --request GET \
--url https://api.signal.apollodeploy.com/v1/metrics/emails/{id}/engagement \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.signal.apollodeploy.com/v1/metrics/emails/{id}/engagement"
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/emails/{id}/engagement', 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/emails/{id}/engagement",
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/emails/{id}/engagement"
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/emails/{id}/engagement")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.signal.apollodeploy.com/v1/metrics/emails/{id}/engagement")
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{
"computedAt": "<string>",
"depth100Count": 123,
"depth25Count": 123,
"depth50Count": 123,
"depth75Count": 123,
"emailId": "<string>",
"readEngaged": true,
"shortEmail": true,
"subject": "<string>",
"depth100Rate": 123,
"depth25Rate": 123,
"depth50Rate": 123,
"depth75Rate": 123,
"deviceType": "<string>",
"mailClient": "<string>",
"maxDepthPct": 123,
"os": "<string>",
"readCategory": "<string>",
"readEngagedAt": "<string>",
"readTimeSeconds": 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>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>",
"errors": [
{
"detail": "<string>",
"pointer": "<string>"
}
],
"instance": "<string>",
"requestId": "<string>"
}