Comms Delivery Events

Return daily delivery event counts grouped by channel and event type.

Method

GET /v1/analytics/comms/delivery-events

Query Parameters

from · string · required

Start date (YYYY-MM-DD, inclusive).

to · string · required

End date (YYYY-MM-DD, inclusive).

workspaceId · uuid · required

Workspace identifier.

Headers

Authorization · string

Bearer token with analytics:read scope.

Request Example

cURL

curl "https://api.voyantcloud.com/v1/analytics/comms/delivery-events?from=2025-02-01&to=2025-02-07&workspaceId=ws_abc" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

Response

200 OK

[
  { "day": "2025-02-01", "channel": "email", "event": "delivered", "cnt": 1284 },
  { "day": "2025-02-01", "channel": "email", "event": "opened", "cnt": 742 },
  { "day": "2025-02-02", "channel": "sms", "event": "delivered", "cnt": 96 }
]

Use the event field to separate provider-specific delivery states (delivered, opened, bounced, etc.) when charting performance.