Documentation Index
Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt
Use this file to discover all available pages before exploring further.
Analytics API
Aggregated analytics over message traffic, deliverability, costs, and goal conversions. All read endpoints are served from a database read-replica, so they’re cheap to call but lag the primary by 1-3 seconds.
Base path: /v1/analytics
Authentication: API key (X-API-Key) or session JWT.
Message analytics
| Method | Path | Purpose |
|---|
GET | /v1/analytics/messages | Message volume, status breakdown, time series |
GET | /v1/analytics/messages/by-channel | Volume per channel |
GET | /v1/analytics/messages/by-country | Volume per destination country |
GET | /v1/analytics/messages/errors | Error-code rollup |
GET | /v1/analytics/costs | Cost per channel / country / day |
GET | /v1/analytics/deliverability | Delivery, read, click rates |
Scheduled reports
Email-delivered analytics rollups on a schedule.
| Method | Path | Purpose |
|---|
GET | /v1/analytics/scheduled-reports | List |
POST | /v1/analytics/scheduled-reports | Create |
PATCH | /v1/analytics/scheduled-reports/{id} | Update |
DELETE | /v1/analytics/scheduled-reports/{id} | Delete |
POST | /v1/analytics/scheduled-reports/{id}/send-now | Trigger an out-of-band run |
Conversion goals
A goal is a tracked conversion (signup, purchase, trial start, etc.). Hits are recorded server-side via record, or via the /g/:goalId/:contactId.gif tracking pixel for browser conversion attribution.
| Method | Path | Purpose |
|---|
GET | /v1/analytics/goals/ | List goals |
POST | /v1/analytics/goals/ | Create a goal |
GET | /v1/analytics/goals/{id} | Get a goal |
PATCH | /v1/analytics/goals/{id} | Update |
DELETE | /v1/analytics/goals/{id} | Delete |
POST | /v1/analytics/goals/{id}/record | Record a conversion server-side |
GET | /v1/analytics/goals/{id}/conversions | List conversions |
GET | /v1/analytics/goals/{id}/stats | Conversion rate, attribution rollup |
See also
