Comms Dispatch Status

Retrieve dispatch status counts (queued, sending, sent, failed) per day.

Method

GET /v1/analytics/comms/dispatch-status

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/dispatch-status?from=2025-02-01&to=2025-02-07&workspaceId=ws_abc" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

Response

200 OK

[
  { "day": "2025-02-01", "status": "queued", "cnt": 320 },
  { "day": "2025-02-01", "status": "sent", "cnt": 1180 },
  { "day": "2025-02-02", "status": "failed", "cnt": 12 }
]

Track the ratio of failed to sent to identify provider outages or content issues affecting dispatch completion.