Skip to main content
flag
Mon - Fri   10:00 – 18:00

Usage Report

API Documentation / WhatsApp / Usage Report

Base URL for your account: https://cpaas.studio

GET /api/whatsapp/v1/reports/usage

Daily counts and charges per category (at most 93 days per request). Kept indefinitely, after message details age out.

Parameters

Param Type Required Notes
from / to Y-m-d no Default: the last 30 days.
channel string no
category string no

Request example

curl -X GET "https://cpaas.studio/api/whatsapp/v1/reports/usage?from=2026-10-01&to=2026-10-10" \
  -H "X-API-KEY: cpk_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Success response (data)

{
    "usage": {
        "from": "2026-10-01",
        "to": "2026-10-10",
        "currency": "INR",
        "days": [
            {
                "date": "2026-10-10",
                "category": "utility",
                "submitted": 1200,
                "sent": 1190,
                "delivered": 1150,
                "read": 700,
                "failed": 4,
                "skipped": 30,
                "inbound": 0,
                "charged": 138
            }
        ]
    }
}

Need more context? See Getting started for authentication, the response envelope, and the full error-code reference.