Read the cross-campaign rollup

{
  "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"
  }
}

{
  "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"
  }
}

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.

Template lifecycle samples

The examples below use the same { data, meta } response envelope as the generated operations. Template writes are tenant-scoped and require the templates:write scope. WhatsApp templates enter carrier approval after creation; do not send the template until its status is approved.

Create a template

POST /api/v1/messages/templates

Create a WhatsApp template with a text body and one variable. The components array uses WhatsApp’s component names and parameter placeholders.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/messages/templates" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "order_ready",
  "channel": "whatsapp",
  "language": "en_US",
  "category": "UTILITY",
  "components": [
    {"type": "BODY", "text": "Hi {{1}}, your order {{2}} is ready for pickup."}
  ]
}'

Node.js

const res = await fetch('https://api.orbit.devotel.io/api/v1/messages/templates', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'order_ready',
    channel: 'whatsapp',
    language: 'en_US',
    category: 'UTILITY',
    components: [
      { type: 'BODY', text: 'Hi {{1}}, your order {{2}} is ready for pickup.' },
    ],
  }),
})
console.log(await res.json())

Python

import os, requests

r = requests.post(
    "https://api.orbit.devotel.io/api/v1/messages/templates",
    headers={
        "X-API-Key": os.environ["ORBIT_API_KEY"],
        "Content-Type": "application/json",
    },
    json={
        "name": "order_ready",
        "channel": "whatsapp",
        "language": "en_US",
        "category": "UTILITY",
        "components": [{"type": "BODY", "text": "Hi {{1}}, your order {{2}} is ready for pickup."}],
    },
)
print(r.json())

{
  "data": {
    "id": "tpl_7b2c91de",
    "name": "order_ready",
    "channel": "whatsapp",
    "language": "en_US",
    "category": "UTILITY",
    "status": "pending_approval",
    "components": [
      {"type": "BODY", "text": "Hi {{1}}, your order {{2}} is ready for pickup."}
    ]
  },
  "meta": {
    "request_id": "req_tpl_create",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Bulk locale-variant create

POST /api/v1/messages/templates/{id}/localize

Pass one to 25 target locales to auto-generate one template row per locale. The operation is copy-only: it creates and submits variants for carrier approval, selects no route, and sends no messages. Use a stable Idempotency-Key when retrying a timed-out request.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/messages/templates/tpl_7b2c91de/localize" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Idempotency-Key: order-ready-locales-v1" \
  -H "Content-Type: application/json" \
  -d '{"targetLocales":["es_ES","fr_FR","de_DE"]}'

Node.js

const res = await fetch('https://api.orbit.devotel.io/api/v1/messages/templates/tpl_7b2c91de/localize', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Idempotency-Key': 'order-ready-locales-v1',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ targetLocales: ['es_ES', 'fr_FR', 'de_DE'] }),
})
console.log(await res.json())

Python

import os, requests

r = requests.post(
    "https://api.orbit.devotel.io/api/v1/messages/templates/tpl_7b2c91de/localize",
    headers={
        "X-API-Key": os.environ["ORBIT_API_KEY"],
        "Idempotency-Key": "order-ready-locales-v1",
        "Content-Type": "application/json",
    },
    json={"targetLocales": ["es_ES", "fr_FR", "de_DE"]},
)
print(r.json())

{
  "data": [
    {"id": "tpl_es_34a1", "language": "es_ES", "status": "pending_approval"},
    {"id": "tpl_fr_34a1", "language": "fr_FR", "status": "pending_approval"},
    {"id": "tpl_de_34a1", "language": "de_DE", "status": "pending_approval"}
  ],
  "meta": {
    "request_id": "req_tpl_localize",
    "timestamp": "2026-08-01T12:01:00.000Z"
  }
}

Update a template

PATCH /api/v1/messages/templates/{id}

Update editable content without changing the template’s channel. Changing WhatsApp content can return the template to carrier approval, so wait for status: "approved" before sending the revised version.

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/messages/templates/tpl_7b2c91de" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"components":[{"type":"BODY","text":"Hi {{1}}, order {{2}} is ready at the front desk."}]}'

Node.js

const res = await fetch('https://api.orbit.devotel.io/api/v1/messages/templates/tpl_7b2c91de', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    components: [{ type: 'BODY', text: 'Hi {{1}}, order {{2}} is ready at the front desk.' }],
  }),
})
console.log(await res.json())

Python

import os, requests

r = requests.patch(
    "https://api.orbit.devotel.io/api/v1/messages/templates/tpl_7b2c91de",
    headers={
        "X-API-Key": os.environ["ORBIT_API_KEY"],
        "Content-Type": "application/json",
    },
    json={"components": [{"type": "BODY", "text": "Hi {{1}}, order {{2}} is ready at the front desk."}]},
)
print(r.json())

{
  "data": {
    "id": "tpl_7b2c91de",
    "channel": "whatsapp",
    "status": "pending_approval",
    "components": [
      {"type": "BODY", "text": "Hi {{1}}, order {{2}} is ready at the front desk."}
    ]
  },
  "meta": {
    "request_id": "req_tpl_update",
    "timestamp": "2026-08-01T12:02:00.000Z"
  }
}

Carrier-rejected template (422)

A carrier rejection is terminal for that submission. Branch on error.code and fix the template or its tenant-owned WhatsApp configuration before submitting again; do not blind-retry the same payload.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/messages/templates" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"name":"order_ready","channel":"whatsapp","language":"en_US","category":"UTILITY","components":[{"type":"BODY","text":"Buy now!!!"}]}'

Node.js

const res = await fetch('https://api.orbit.devotel.io/api/v1/messages/templates', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'order_ready', channel: 'whatsapp', language: 'en_US', category: 'UTILITY',
    components: [{ type: 'BODY', text: 'Buy now!!!' }],
  }),
})
console.log(await res.json())

Python

import os, requests

r = requests.post(
    "https://api.orbit.devotel.io/api/v1/messages/templates",
    headers={"X-API-Key": os.environ["ORBIT_API_KEY"], "Content-Type": "application/json"},
    json={"name": "order_ready", "channel": "whatsapp", "language": "en_US", "category": "UTILITY", "components": [{"type": "BODY", "text": "Buy now!!!"}]},
)
print(r.json())

{
  "error": {
    "code": "WHATSAPP_TEMPLATE_REJECTED",
    "message": "The carrier rejected this template",
    "status": 422,
    "details": {"reason": "PROMOTIONAL_LANGUAGE_NOT_ALLOWED"}
  },
  "meta": {
    "request_id": "req_tpl_rejected",
    "timestamp": "2026-08-01T12:03:00.000Z"
  }
}

API Reference

All Endpoints

Read the cross-campaign rollup