Metrics
Get project metrics timeline
Returns project metrics bucketed by hour or day. Use format=detailed for per-status series or format=compact for the compact timeline.
Requirements
- Permission:
emails:sendoremails:readormetrics:read. - HTTP rate limit: 120 requests per 60 seconds per API key.
GET
/
v1
/
metrics
/
timeline
Get project metrics timeline
curl --request GET \
--url https://api.signal.apollodeploy.com/v1/metrics/timeline \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.signal.apollodeploy.com/v1/metrics/timeline"
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/timeline', 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/timeline",
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/timeline"
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/timeline")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.signal.apollodeploy.com/v1/metrics/timeline")
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{
"buckets": [
{
"bounceRate": 123,
"bounced": 123,
"bucket": "<string>",
"clickRate": 123,
"clicked": 123,
"complained": 123,
"complaintRate": 123,
"delivered": 123,
"deliveryDelayed": 123,
"deliveryRate": 123,
"engagementScore": 123,
"failed": 123,
"openRate": 123,
"opened": 123,
"readEngaged": 123,
"readEngagementRate": 123,
"sent": 123,
"unsubscribed": 123,
"bounceRateDelta": 123,
"deliveredDelta": 123,
"openRateDelta": 123,
"sentDelta": 123
}
],
"format": "<string>",
"granularity": "<string>",
"projectId": "<string>",
"totals": {
"avgEngagementScore": 123,
"bounceRate": 123,
"bounced": 123,
"clickRate": 123,
"clicked": 123,
"complained": 123,
"complaintRate": 123,
"delivered": 123,
"deliveryRate": 123,
"failed": 123,
"openRate": 123,
"opened": 123,
"readEngaged": 123,
"readEngagementRate": 123,
"sent": 123,
"unsubscribed": 123,
"peakBucket": "<string>"
},
"window": {
"from": "<string>",
"label": "<string>",
"to": "<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>"
}{
"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
Metrics time window.
hour or day.
compact or detailed.
Required for session auth; ignored for API key auth.
Response
Request completed successfully.
Was this page helpful?
⌘I
Get project metrics timeline
curl --request GET \
--url https://api.signal.apollodeploy.com/v1/metrics/timeline \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.signal.apollodeploy.com/v1/metrics/timeline"
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/timeline', 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/timeline",
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/timeline"
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/timeline")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.signal.apollodeploy.com/v1/metrics/timeline")
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{
"buckets": [
{
"bounceRate": 123,
"bounced": 123,
"bucket": "<string>",
"clickRate": 123,
"clicked": 123,
"complained": 123,
"complaintRate": 123,
"delivered": 123,
"deliveryDelayed": 123,
"deliveryRate": 123,
"engagementScore": 123,
"failed": 123,
"openRate": 123,
"opened": 123,
"readEngaged": 123,
"readEngagementRate": 123,
"sent": 123,
"unsubscribed": 123,
"bounceRateDelta": 123,
"deliveredDelta": 123,
"openRateDelta": 123,
"sentDelta": 123
}
],
"format": "<string>",
"granularity": "<string>",
"projectId": "<string>",
"totals": {
"avgEngagementScore": 123,
"bounceRate": 123,
"bounced": 123,
"clickRate": 123,
"clicked": 123,
"complained": 123,
"complaintRate": 123,
"delivered": 123,
"deliveryRate": 123,
"failed": 123,
"openRate": 123,
"opened": 123,
"readEngaged": 123,
"readEngagementRate": 123,
"sent": 123,
"unsubscribed": 123,
"peakBucket": "<string>"
},
"window": {
"from": "<string>",
"label": "<string>",
"to": "<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>"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"detail": "<string>",
"errors": [
{
"detail": "<string>",
"pointer": "<string>"
}
],
"instance": "<string>",
"requestId": "<string>"
}