Create a scheduled analytics report
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/analytics/scheduled-reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Weekly deliverability",
"type": "deliverability",
"frequency": "weekly",
"recipients": [
"ops@acme.com"
],
"enabled": true,
"timezone": "America/New_York"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/analytics/scheduled-reports"
payload = {
"name": "Weekly deliverability",
"type": "deliverability",
"frequency": "weekly",
"recipients": ["ops@acme.com"],
"enabled": True,
"timezone": "America/New_York"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Weekly deliverability',
type: 'deliverability',
frequency: 'weekly',
recipients: ['ops@acme.com'],
enabled: true,
timezone: 'America/New_York'
})
};
fetch('https://api.orbit.devotel.io/api/v1/analytics/scheduled-reports', 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.orbit.devotel.io/api/v1/analytics/scheduled-reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Weekly deliverability',
'type' => 'deliverability',
'frequency' => 'weekly',
'recipients' => [
'ops@acme.com'
],
'enabled' => true,
'timezone' => 'America/New_York'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/analytics/scheduled-reports"
payload := strings.NewReader("{\n \"name\": \"Weekly deliverability\",\n \"type\": \"deliverability\",\n \"frequency\": \"weekly\",\n \"recipients\": [\n \"ops@acme.com\"\n ],\n \"enabled\": true,\n \"timezone\": \"America/New_York\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/analytics/scheduled-reports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Weekly deliverability\",\n \"type\": \"deliverability\",\n \"frequency\": \"weekly\",\n \"recipients\": [\n \"ops@acme.com\"\n ],\n \"enabled\": true,\n \"timezone\": \"America/New_York\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/analytics/scheduled-reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Weekly deliverability\",\n \"type\": \"deliverability\",\n \"frequency\": \"weekly\",\n \"recipients\": [\n \"ops@acme.com\"\n ],\n \"enabled\": true,\n \"timezone\": \"America/New_York\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "rpt_7c1f0a",
"organization_id": "org_42",
"name": "Weekly deliverability",
"type": "deliverability",
"frequency": "weekly",
"recipients": [
"ops@acme.com"
],
"filters": null,
"enabled": true,
"timezone": "America/New_York",
"last_sent_at": "2026-07-26T13:00:00.000Z",
"next_send_at": "2026-08-02T13:00:00.000Z",
"created_by": "usr_9",
"created_at": "2026-06-01T10:00:00.000Z",
"updated_at": "2026-07-26T13:00:00.000Z"
},
"meta": {
"request_id": "req_9f2c1a7b",
"timestamp": "2026-08-02T12:00:00.000Z"
}
}Analytics
Create a scheduled analytics report
Schedules a recurring analytics report emailed to one or more recipients on a daily, weekly or monthly cadence. Choose a report type (messaging_volume, deliverability, top_contacts, spend or custom), 1–50 unique recipient emails, optional filters (a custom report’s filters.dataset selects the messages or queue_performance dataset), an enabled flag, and an IANA timezone the cadence anchors to. Requires an owner, admin or developer role; returns the created report with its computed next_send_at.
POST
/
api
/
v1
/
analytics
/
scheduled-reports
Create a scheduled analytics report
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/analytics/scheduled-reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Weekly deliverability",
"type": "deliverability",
"frequency": "weekly",
"recipients": [
"ops@acme.com"
],
"enabled": true,
"timezone": "America/New_York"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/analytics/scheduled-reports"
payload = {
"name": "Weekly deliverability",
"type": "deliverability",
"frequency": "weekly",
"recipients": ["ops@acme.com"],
"enabled": True,
"timezone": "America/New_York"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Weekly deliverability',
type: 'deliverability',
frequency: 'weekly',
recipients: ['ops@acme.com'],
enabled: true,
timezone: 'America/New_York'
})
};
fetch('https://api.orbit.devotel.io/api/v1/analytics/scheduled-reports', 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.orbit.devotel.io/api/v1/analytics/scheduled-reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Weekly deliverability',
'type' => 'deliverability',
'frequency' => 'weekly',
'recipients' => [
'ops@acme.com'
],
'enabled' => true,
'timezone' => 'America/New_York'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/analytics/scheduled-reports"
payload := strings.NewReader("{\n \"name\": \"Weekly deliverability\",\n \"type\": \"deliverability\",\n \"frequency\": \"weekly\",\n \"recipients\": [\n \"ops@acme.com\"\n ],\n \"enabled\": true,\n \"timezone\": \"America/New_York\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/analytics/scheduled-reports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Weekly deliverability\",\n \"type\": \"deliverability\",\n \"frequency\": \"weekly\",\n \"recipients\": [\n \"ops@acme.com\"\n ],\n \"enabled\": true,\n \"timezone\": \"America/New_York\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/analytics/scheduled-reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Weekly deliverability\",\n \"type\": \"deliverability\",\n \"frequency\": \"weekly\",\n \"recipients\": [\n \"ops@acme.com\"\n ],\n \"enabled\": true,\n \"timezone\": \"America/New_York\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "rpt_7c1f0a",
"organization_id": "org_42",
"name": "Weekly deliverability",
"type": "deliverability",
"frequency": "weekly",
"recipients": [
"ops@acme.com"
],
"filters": null,
"enabled": true,
"timezone": "America/New_York",
"last_sent_at": "2026-07-26T13:00:00.000Z",
"next_send_at": "2026-08-02T13:00:00.000Z",
"created_by": "usr_9",
"created_at": "2026-06-01T10:00:00.000Z",
"updated_at": "2026-07-26T13:00:00.000Z"
},
"meta": {
"request_id": "req_9f2c1a7b",
"timestamp": "2026-08-02T12:00:00.000Z"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Required string length:
1 - 120Available options:
messaging_volume, deliverability, top_contacts, spend, custom Available options:
daily, weekly, monthly 1–50 unique recipient emails, as an array or a comma-separated string.
Optional saved-query definition; filters.dataset must name a known dataset when present.
IANA zone name, e.g. America/New_York.
⌘I