Sign in
Mass Messaging

List Mass Message Statistics

List mass messaging statistics, showing the send count and view count.

get/api/{account}/mass-messaging/statistics

Query parameters

limitinteger

Number of mass messages to return (default = 20)

Example:20

Number of mass messages to return (default = 20)

offsetinteger

Number of mass messages to skip for pagination

Number of mass messages to skip for pagination

querystring

Optionally, find a mass message by the message text.

Example:My message text

Optionally, find a mass message by the message text.

type'sent' | 'scheduled' | 'unsent'

Filter by sent / scheduled / unsent (default = sent)

Example:sent

Filter by sent / scheduled / unsent (default = sent)

Response

Example response

{
  "data": {
    "list": [
      {
        "id": 123,
        "date": "2025-01-01T01:01:01+01:01",
        "text": "<p>Text</p>",
        "giphyId": null,
        "textCropped": "<p>Text</p>",
        "isFree": true,
        "sentCount": 123,
        "viewedCount": 123,
        "canUnsend": true,
        "unsendSeconds": 1000000,
        "isCanceled": false,
        "mediaTypes": null,
        "hasError": false,
        "releaseForms": []
      },
      {
        "id": 124,
        "date": "2025-01-01T01:01:01+01:01",
        "text": "<p>PPV Example</p>",
        "giphyId": null,
        "textCropped": "<p>PPV Example</p>",
        "isFree": false,
        "sentCount": 0,
        "viewedCount": 0,
        "canUnsend": false,
        "unsendSeconds": 0,
        "isCanceled": true,
        "mediaTypes": {
          "photo": 2
        },
        "hasError": false,
        "price": "5.00",
        "purchasedCount": 0,
        "canSendMessageToBuyers": false,
        "releaseForms": []
      }
    ],
    "hasMore": false
  },
  "_meta": {
    "_credits": {
      "used": 1,
      "balance": 999999990,
      "note": "Always"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    },
    "_rate_limits": {
      "limit_minute": 60,
      "limit_day": 500,
      "remaining_minute": 59,
      "remaining_day": 484
    }
  }
}

Changes