Get Campaign (Analytics)
curl --request GET \
--url https://api-ai.textyess.com/analytics/campaigns/{campaignId} \
--header 'x-auth-token: <api-key>'import requests
url = "https://api-ai.textyess.com/analytics/campaigns/{campaignId}"
headers = {"x-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};
fetch('https://api-ai.textyess.com/analytics/campaigns/{campaignId}', 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-ai.textyess.com/analytics/campaigns/{campaignId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-auth-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-ai.textyess.com/analytics/campaigns/{campaignId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-auth-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-ai.textyess.com/analytics/campaigns/{campaignId}")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-ai.textyess.com/analytics/campaigns/{campaignId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_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"
}
null
{
"message": "Unauthorized"
}
Analytics API
Get Campaign (Analytics)
Get analytics metrics for a single campaign
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>'import requests
url = "https://api-ai.textyess.com/analytics/campaigns/{campaignId}"
headers = {"x-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};
fetch('https://api-ai.textyess.com/analytics/campaigns/{campaignId}', 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-ai.textyess.com/analytics/campaigns/{campaignId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-auth-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-ai.textyess.com/analytics/campaigns/{campaignId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-auth-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-ai.textyess.com/analytics/campaigns/{campaignId}")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-ai.textyess.com/analytics/campaigns/{campaignId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_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"
}
null
{
"message": "Unauthorized"
}
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 returnsnull.
Authentication
This endpoint requires a valid JWT token in thex-auth-token header. You can find your token in the Developers section:
x-auth-token: your_jwt_token
Path Parameters
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, ornull if the campaign is not found or has no message events.
{
"_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"
}
null
{
"message": "Unauthorized"
}