StatusDashboard
SMS

SMS send history

Retrieve daily event notification SMS send counts for a UTC calendar month.

View Markdown

GET /app/notifications/sms/history

Returns a dense daily series of event notification SMS send counts for one UTC calendar month. Counts match the same population as the monthly SMS message quota on Overview.

Requires the admin or subscriber role and the SMS notifications feature entitlement.


Request

See API Basics for required headers.

Query parameters

ParameterTypeRequiredDescription
monthstringNoUTC calendar month in YYYY-MM format. Defaults to the current UTC month. Must be within the navigable window (current month plus the prior 12 months).

Sample request

curl "https://api.statusdashboard.com/app/notifications/sms/history?month=2026-06" \
  -H "Authorization: Bearer bcf847abf5c6:def456"

Sample response

Status: 200 OK

{
  "month": "2026-06",
  "timezone": "UTC",
  "days": [
    { "date": "2026-06-01", "count": 0 },
    { "date": "2026-06-02", "count": 5 }
  ],
  "total": 5,
  "navigation": {
    "canGoBack": true,
    "canGoForward": true,
    "previousMonth": "2026-05",
    "nextMonth": "2026-07"
  }
}

Response fields

FieldTypeDescription
monthstringResolved UTC calendar month (YYYY-MM).
timezonestringAlways "UTC".
daysarrayDense list of every calendar day in the month (28–31 entries). Missing days are returned with count: 0.
days[].datestringUTC calendar day (YYYY-MM-DD).
days[].countintegerNon-negative send count for that day.
totalintegerSum of all days[].count values.
navigation.canGoBackbooleantrue when previousMonth is within the navigable window.
navigation.canGoForwardbooleantrue when nextMonth is within the navigable window.
navigation.previousMonthstring | nullPrior month (YYYY-MM) or null.
navigation.nextMonthstring | nullNext month (YYYY-MM) or null.

Error responses

StatusWhen
400Invalid month format, future month, or month outside the navigable window
403Missing role or SMS feature entitlement
500Unexpected server error

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.