---
title: "Get Mass Message Overview"
method: GET
path: "/api/{account}/mass-messaging/overview"
tags: ["Mass Messaging"]
---

# Get Mass Message Overview

`GET /api/{account}/mass-messaging/overview`

Get an overview of mass messages, showing the send count and view count.

## Query parameters

- `startDate` string — The earliest mass message to retrieve. Keep empty to get all.
- `endDate` string — The latest mass message to retrieve. Keep empty to get all. MUST BE DATE AFTER `startDate`. This is also used for pagination.
- `limit` integer — Number of mass messages to return (default = 10)
- `query` string — Optionally, find a mass message by the message text.

## Response `200`

- object
  - `data` object
    - `hasMore` boolean
    - `items` object[]
      - `id` integer
      - `date` string
      - `responseType` string
      - `text` string
      - `rawText` string
      - `giphyId` string, nullable
      - `isFree` boolean
      - `isMediaReady` boolean
      - `mediaCount` integer
      - `media` object[]
        - `id` integer
        - `type` string
        - `convertedToVideo` boolean
        - `canView` boolean
        - `hasError` boolean
        - `createdAt` string
        - `isReady` boolean
        - `files` object
          - `full` object
            - `url` string
            - `width` integer
            - `height` integer
            - `size` integer
            - `sources` unknown[]
              - …
          - `thumb` object
            - `url` string
            - `width` integer
            - `height` integer
            - `size` integer
          - `preview` object
            - `url` string
            - `width` integer
            - `height` integer
            - `size` integer
          - `squarePreview` object
            - `url` string
            - `width` integer
            - `height` integer
            - `size` integer
        - `duration` integer
        - `hasCustomPreview` boolean
        - `videoSources` object
          - `240` string, nullable
          - `720` string, nullable
      - `previews` unknown[]
        - unknown
      - `isTip` boolean
      - `isReportedByMe` boolean
      - `viewedCount` integer
      - `sentCount` integer
      - `isCanceled` boolean
      - `template` string
      - `canUnsend` boolean
      - `unsendSeconds` integer
  - `_meta` object
    - `_credits` object
      - `used` integer
      - `balance` integer
      - `note` string
    - `_cache` object
      - `is_cached` boolean
      - `note` string
    - `_rate_limits` object
      - `limit_minute` integer
      - `limit_day` integer
      - `remaining_minute` integer
      - `remaining_day` integer

---

[API](https://skmtc.net/onlyfansapi/apis/onlyfans-api.md) · [All operations](https://skmtc.net/onlyfansapi/apis/onlyfans-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onlyfansapi/onlyfans-api/revisions/4a99d36f28a3/schema)