Skip to main content
GET
/
analytics
/
campaigns
/
{campaignId}
Get Campaign (Analytics)
curl --request GET \
  --url https://api-ai.textyess.com/analytics/campaigns/{campaignId} \
  --header 'x-auth-token: <api-key>'
{
  "_id": "507f1f77bcf86cd799439011",
  "campaign": {
    "_id": "507f1f77bcf86cd799439011",
    "name": "Summer Sale",
    "createdAt": "2024-01-10T08:00:00.000Z"
  },
  "total_messages": 5000,
  "cost": 25000,
  "revenue": 125000,
  "orders_number": 120,
  "campaign_conversion_rate": 2.4,
  "average_cart": 1041.67,
  "roas": 5,
  "campaign_type": "campaigns"
}

​
Overview

The get campaign endpoint returns aggregated analytics (messages, cost, revenue, orders, conversion rate, ROAS) for a single campaign by ID. If the campaign ID is invalid or no message events exist for it, the API returns null.

​
Authentication

This endpoint requires a valid JWT token in the x-auth-token header. You can find your token in the Developers section: 
x-auth-token: your_jwt_token

​
Path Parameters

​
campaignId
string
required
The unique identifier of the campaign (MongoDB ObjectId). Supports both classic campaigns and outbound automations/flows.

​
Response

The response is a single campaign analytics object, or null if the campaign is not found or has no message events.
​
_id
string
Campaign (asset) ID
​
campaign
object
Campaign document (name, createdAt, etc.)
​
total_messages
number
Total messages sent for this campaign in the default date range
​
cost
number
Total cost in cents
​
revenue
number
Attributed revenue
​
orders_number
number
Number of attributed orders
​
campaign_conversion_rate
number
Conversion rate (orders / messages) as a percentage
​
average_cart
number
Average order value (revenue / orders)
​
roas
number
Return on ad spend (revenue / cost)
​
campaign_type
string
Asset type: campaigns or outbound-automations
{
  "_id": "507f1f77bcf86cd799439011",
  "campaign": {
    "_id": "507f1f77bcf86cd799439011",
    "name": "Summer Sale",
    "createdAt": "2024-01-10T08:00:00.000Z"
  },
  "total_messages": 5000,
  "cost": 25000,
  "revenue": 125000,
  "orders_number": 120,
  "campaign_conversion_rate": 2.4,
  "average_cart": 1041.67,
  "roas": 5,
  "campaign_type": "campaigns"
}