Templates API

Templates endpoints exposed by the Devotel CPaaS API Base path: /api/v1/templates Endpoint count: 2

title: “Read the cross-campaign rollup” description: “What one reusable template accumulates across every campaign that sent it — totals, conversion rates, and a per-campaign funnel in a single response.”

Read the cross-campaign rollup

A template you reuse — an order confirmation, an appointment reminder, a promo blast — gets its engagement scored here instead of campaign by campaign. Product and lifecycle marketers use this endpoint to answer “which message actually converts” before cloning the winner into the next send. Grab a template id via the templates list (or the dashboard’s campaign detail page), then fetch GET /api/v1/templates/{id}/analytics. The response consolidates the template’s engagement across every campaign that used it: headline counters (totals), conversion fractions (rates), and a per-campaign funnel (campaigns) — plus a degraded flag marking zeroed fallback responses during a transient database blip. Request

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/templates/tpl_9f2c4a1b/analytics" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/templates/tpl_9f2c4a1b/analytics', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/templates/tpl_9f2c4a1b/analytics", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/templates/tpl_9f2c4a1b/analytics", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/templates/tpl_9f2c4a1b/analytics')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/templates/tpl_9f2c4a1b/analytics');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "template": {
      "id": "tpl_9f2c4a1b",
      "name": "order_confirmation_v2",
      "channel": "whatsapp",
      "status": "approved"
    },
    "totals": {
      "campaigns": 3,
      "sent": 48200,
      "delivered": 46110,
      "failed": 1240,
      "terminal": 47350,
      "opened": 21050,
      "clicked": 5180
    },
    "rates": {
      "delivery_rate": 0.96,
      "open_rate": 0.46,
      "click_rate": 0.11
    },
    "campaigns": [
      {
        "campaign_id": "camp_a1b2c3d4",
        "campaign_name": "May promo",
        "channel": "whatsapp",
        "sent": 12000,
        "delivered": 11580,
        "failed": 410,
        "opened": 6200,
        "clicked": 1540
      }
    ],
    "degraded": false
  },
  "meta": {
    "request_id": "req_tpl_roll",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Two details change how you read the numbers. Terminal is the denominator, not sent — the delivery rate divides delivered by terminal messages (those that reached a final state), so an in-flight campaign reports an honest rate instead of a send-padded one. And degraded: true means “no data right now,” not “zero engagement” — during a transient database blip the endpoint returns a zeroed fallback with the flag set; treat it as “retry shortly.” See the template analytics guide for the walk-through on comparing template versions, spotting a delivery drop after an edit, and breaking results down by channel.

List templates

GET /api/v1/templates

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/templates" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/templates', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/templates", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/templates", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/templates')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/templates');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "template": {
      "id": "tpl_9f2c4a1b",
      "name": "order_confirmation_v2",
      "channel": "whatsapp",
      "status": "approved"
    },
    "totals": {
      "campaigns": 3,
      "sent": 48200,
      "delivered": 46110,
      "failed": 1240,
      "terminal": 47350,
      "opened": 21050,
      "clicked": 5180
    },
    "rates": {
      "delivery_rate": 0.96,
      "open_rate": 0.46,
      "click_rate": 0.11
    },
    "campaigns": [
      {
        "campaign_id": "camp_a1b2c3d4",
        "campaign_name": "May promo",
        "channel": "whatsapp",
        "sent": 12000,
        "delivered": 11580,
        "failed": 410,
        "opened": 6200,
        "clicked": 1540
      }
    ],
    "degraded": false
  },
  "meta": {
    "request_id": "req_tpl_roll",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Get template cross-campaign analytics

GET /api/v1/templates/{id}/analytics

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/templates/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "template": {
      "id": "tpl_9f2c4a1b",
      "name": "order_confirmation_v2",
      "channel": "whatsapp",
      "status": "approved"
    },
    "totals": {
      "campaigns": 3,
      "sent": 48200,
      "delivered": 46110,
      "failed": 1240,
      "terminal": 47350,
      "opened": 21050,
      "clicked": 5180
    },
    "rates": {
      "delivery_rate": 0.96,
      "open_rate": 0.46,
      "click_rate": 0.11
    },
    "campaigns": [
      {
        "campaign_id": "camp_a1b2c3d4",
        "campaign_name": "May promo",
        "channel": "whatsapp",
        "sent": 12000,
        "delivered": 11580,
        "failed": 410,
        "opened": 6200,
        "clicked": 1540
      }
    ],
    "degraded": false
  },
  "meta": {
    "request_id": "req_tpl_roll",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

API Reference

All Endpoints

Templates API

Templates API

title: “Read the cross-campaign rollup” description: “What one reusable template accumulates across every campaign that sent it — totals, conversion rates, and a per-campaign funnel in a single response.”

Read the cross-campaign rollup

List templates

Get template cross-campaign analytics

​Templates API

​title: “Read the cross-campaign rollup” description: “What one reusable template accumulates across every campaign that sent it — totals, conversion rates, and a per-campaign funnel in a single response.”

​Read the cross-campaign rollup

​List templates

​Get template cross-campaign analytics

Templates API

title: “Read the cross-campaign rollup” description: “What one reusable template accumulates across every campaign that sent it — totals, conversion rates, and a per-campaign funnel in a single response.”

Read the cross-campaign rollup

List templates

Get template cross-campaign analytics