SMS

SMS delivery stats

Retrieve aggregate SMS delivery metrics for your workspace over a rolling window: how many texts were queued, sent, delivered, failed, suppressed (skipped on purpose: no consent, opted out, no sender that reaches the country) or canceled, how many replies came in, and how many segments were billed, with delivery, failure and suppression rates. There are no open or click numbers: carriers report sent, delivered and failed only. Control the window with days (1–365, default 30). For the messages behind these numbers, see List SMS messages. Requires the sms:read capability.

get/sms/stats

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/sms/stats
  • Auth: HTTP bearer

Query parameters

daysinteger

Window size in days (1–365). Defaults to 30; values above 365 are rejected.

Response

The stats for the window.

object'sms_stats' required
window_daysinteger required

The rolling window, in days.

clamped_to_retention_daysinteger nullable required

Non-null when the requested window exceeded the plan's log retention and was clamped to this many days.

Changes

No recorded changes to this operation across all 1 revision of this API.