Analytics

Get message stats

GET/analyticsScope analytics:read

Returns message totals for a period and a per-day count, in your workspace's time zone, the same figures as the dashboard.

Query parameters

fromstring
Start, as an ISO 8601 time. Defaults to 30 days ago.
tostring
End, as an ISO 8601 time. Defaults to now.

Good to know

readRate is read divided by sent, between 0 and 1.

Errors

Plus the errors any endpoint can return, such as a missing key or scope. See Errors.

Request

# macOS, Linux or Git Bash, with WAMAFY_API_KEY set. The quoting does not work in Windows cmd or PowerShell.
curl "https://api.wamafy.com/api/v1/public/analytics?from=2026-09-01T00%3A00%3A00Z&to=2026-10-01T00%3A00%3A00Z" \
  -H "Authorization: Bearer $WAMAFY_API_KEY"

Response 200

{
  "success": true,
  "data": {
    "range": {
      "from": "2026-09-01T00:00:00.000Z",
      "to": "2026-10-01T00:00:00.000Z"
    },
    "totals": {
      "sent": 1240,
      "delivered": 1198,
      "read": 903,
      "failed": 12,
      "readRate": 0.728
    },
    "daily": [
      {
        "date": "2026-09-30",
        "count": 41
      }
    ]
  }
}

Base URL https://api.wamafy.com/api/v1/public