Campaigns

Get per-date SMS usage and campaign breakdown

GET
/api/campaigns/usage-calendar

Returns SMS usage (sent + reserved) and the list of scheduled/sent campaigns per organization-local date within the requested range. Each campaign entry lists at most the first 100 failures in failedDetails and carries the campaign's full failure total in failedCount. Used by the Campaigns overview calendar.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

from*string

Inclusive start date (YYYY-MM-DD, org-local timezone).

Formatdate
to*string

Inclusive end date (YYYY-MM-DD, org-local timezone).

Formatdate

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/campaigns/usage-calendar?from=2019-08-24&to=2019-08-24"
{  "success": true,  "data": {    "timezone": "America/Toronto",    "dailyLimit": 500,    "isUnlimited": false,    "plan": "growth",    "dates": {      "2026-05-20": {        "sent": 0,        "reserved": 100,        "total": 100,        "availableQuota": 400,        "campaigns": [          {            "campaignId": "665f1a0c0e0a4b001a2c9f10",            "campaignName": "Q2 Lead Gen",            "contactCount": 100,            "status": "scheduled"          }        ]      }    }  }}