Get Campaign Stats

Retrieve delivery, read, click and conversion stats for a WhatsApp campaign.

Totals are lifetime. Unique counts can lag event counts by up to 15 minutes. Before the campaign is sent, counts are 0 and rates are null.

Finding the campaign ID

WhatsApp campaigns are created in the dashboard. The ID is the last part of the campaign's URL.

Endpoint

GET /whatsapp/campaigns/:id/stats

Returns: 200 OK

Headers

Header	Value	Required
Authorization	Bearer <your-api-key>	Yes

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	The campaign ID.

Response

{
  "object": "whatsapp_campaign_stats",
  "campaign_id": "0192a1b2-c3d4-7e5f-9000-abcdef123456",
  "sent": 3100,
  "delivered": 3020,
  "read": 2410,
  "failed": 80,
  "clicks": 560,
  "unique_reads": 2290,
  "unique_clicks": 498,
  "delivery_rate": 0.9742,
  "read_rate": 0.7583,
  "click_rate": 0.1649,
  "conversions": {
    "enabled": true,
    "tracking_since": "2026-09-01T00:00:00.000Z",
    "total": 42,
    "revenue": [{ "currency": "SAR", "amount": 18350 }],
    "by_event": [
      {
        "event_id": "0192a1b2-eeee-7fff-8000-111111111111",
        "event_name": "order_completed",
        "tracks_revenue": true,
        "conversions": 42,
        "revenue": [{ "currency": "SAR", "amount": 18350 }]
      }
    ]
  }
}

Response fields

Field	Type	Description
sent	number	Accepted by WhatsApp
delivered	number	Delivered to the recipient's device
read	number	Read receipts. Depends on the recipient's privacy settings.
failed	number	Could not be delivered
clicks	number	Total button taps
unique_reads	number	Contacts who read
unique_clicks	number	Contacts who tapped a button
delivery_rate	number | null	delivered / sent
read_rate	number | null	unique_reads / delivered
click_rate	number | null	unique_clicks / delivered
conversions.enabled	boolean	false when the organization has no conversion events
conversions.tracking_since	string | null	When the first conversion event was enabled (ISO 8601)
conversions.total	number	Conversions attributed to the campaign
conversions.revenue	array	Attributed revenue as { currency, amount }, one entry per currency
conversions.by_event	array	The same breakdown per conversion event

Rates are fractions from 0 to 1, rounded to four decimals, and null when the denominator is 0.

---

Examples

cURL

curl "https://api.arsel.sa/v1/whatsapp/campaigns/0192a1b2-c3d4-7e5f-9000-abcdef123456/stats" \
  -H "Authorization: Bearer $ARSEL_API_KEY"

JavaScript

const response = await fetch("https://api.arsel.sa/v1/whatsapp/campaigns/0192a1b2-c3d4-7e5f-9000-abcdef123456/stats", {
  headers: {
    Authorization: `Bearer ${process.env.ARSEL_API_KEY}`,
  },
});

const data = await response.json();
if (!response.ok) {
  throw new Error(`${data.name}: ${data.message}`);
}

console.log(data);

Python

import os

import requests

response = requests.get(
    "https://api.arsel.sa/v1/whatsapp/campaigns/0192a1b2-c3d4-7e5f-9000-abcdef123456/stats",
    headers={"Authorization": f"Bearer {os.environ['ARSEL_API_KEY']}"},
)
response.raise_for_status()

print(response.json())

C#

using System.Net.Http.Headers;

var client = new HttpClient(); // share one instance across requests
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(
    "Bearer", Environment.GetEnvironmentVariable("ARSEL_API_KEY"));

var response = await client.GetAsync("https://api.arsel.sa/v1/whatsapp/campaigns/0192a1b2-c3d4-7e5f-9000-abcdef123456/stats");
var body = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode)
    throw new HttpRequestException($"{(int)response.StatusCode}: {body}");

Console.WriteLine(body);

PHP

<?php
$ch = curl_init("https://api.arsel.sa/v1/whatsapp/campaigns/0192a1b2-c3d4-7e5f-9000-abcdef123456/stats");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("ARSEL_API_KEY"),
    ],
]);

$data = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) >= 400) {
    throw new Exception("{$data['name']}: {$data['message']}");
}

print_r($data);

---

Error Responses

404 Not Found

{
  "status_code": 404,
  "name": "not_found",
  "message": "Campaign not found"
}

401 Unauthorized

{
  "status_code": 401,
  "name": "unauthorized",
  "message": "Invalid API Key"
}