> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onlyfansapi.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Mass Message Overview (/api-reference/mass-messaging/get-mass-message-overview)
Get an overview of mass messages, showing the send count and view count.
## OpenAPI
````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/mass-messaging/overview
openapi: 3.0.3
info:
title: OnlyFans API
description: ""
version: 1.0.0
servers:
- url: https://app.onlyfansapi.com
security:
- default: []
tags:
- name: API Keys
description: ""
- name: Account
description: Endpoints for your linked accounts
- name: Analytics - Financial
description: APIs for retrieving financial analytics data
- name: Analytics - Summary
description: APIs for retrieving summary analytics data
- name: Banking
description: Operations related to user banking details, payout methods, legal
and tax information, and account country settings.
- name: Chargebacks
description: ""
- name: Chat Messages
description: ""
- name: Chats
description: ""
- name: Client Sessions
description: ""
- name: Connect OnlyFans Account
description: ""
- name: Data Exports
description: APIs for managing data exports
- name: Engagement / Messages
description: ""
- name: Fans
description: APIs for managing OnlyFans fans (subscribers)
- name: Fans - AI Summary
description: APIs for generating and retrieving AI-powered fan profile summaries
- name: Following
description: APIs for managing OnlyFans followings (people you're subscribed to)
- name: Free Trial Links
description: APIs for managing Free Trial Links
- name: Giphy
description: ""
- name: Link Tags
description: APIs for managing tags on free trial links and tracking links
- name: Mass Messaging
description: ""
- name: Media
description: ""
- name: Media Vault
description: ""
- name: Media Vault Lists
description: ""
- name: Notifications
description: Endpoints for managingr account notifications
- name: Payouts
description: ""
- name: Post Comments
description: ""
- name: Post Labels
description: APIs for managing your post labels
- name: Posts
description: APIs for managing OnlyFans posts
- name: Promotions
description: ""
- name: Public Profiles
description: ""
- name: Queue
description: ""
- name: Release Forms
description: APIs for managing OnlyFans release forms
- name: Saved For Later (Messages)
description: ""
- name: Saved For Later (Posts)
description: ""
- name: Settings
description: ""
- name: Shared Free Trial Links
description: APIs for Free Trial Links that other OF creators have shared with
this account. Revenue, cost, and spender data are not available for shared
links.
- name: Shared Tracking Links
description: APIs for Tracking Links (campaigns) that other OF creators have
shared with this account. Revenue, cost, and spender data are not
available for shared campaigns.
- name: Smart Link Postbacks
description: APIs for managing Smart Link postback destinations
- name: Smart Links
description: APIs for managing Smart Links (Free Trial Links and Tracking Links
with pooled inventory)
- name: Statistics
description: ""
- name: Stored Free Trial Links
description: Instant APIs for retrieving stored free trial links from the
OnlyFansAPI Cache (free, no credits used)
- name: Stored Shared Free Trial Links
description: Instant APIs for retrieving stored shared Free Trial Links from the
OnlyFansAPI Cache (free, no credits used)
- name: Stored Shared Tracking Links
description: Instant APIs for retrieving stored shared Tracking Links
(campaigns) from the OnlyFansAPI Cache (free, no credits used)
- name: Stored Tracking Links
description: Instant APIs for retrieving stored tracking links from the
OnlyFansAPI Cache (free, no credits used)
- name: Stories
description: APIs for managing OnlyFans stories
- name: Story Highlights
description: APIs for managing OnlyFans story highlights
- name: Subscription Bundles
description: ""
- name: Tracking Links
description: APIs for managing tracking links
- name: Transactions
description: APIs for managing OnlyFans transactions
- name: User List Collections
description: ""
- name: Users
description: APIs for fetching OnlyFans users
- name: Webhooks
description: ""
paths:
/api/{account}/mass-messaging/overview:
parameters:
- in: path
name: account
description: The Account ID
example: acct_XXXXXXXXXXXXXXX
required: true
schema:
type: string
get:
summary: Get Mass Message Overview
operationId: getMassMessageOverview
description: Get an overview of mass messages, showing the send count and view count.
parameters:
- in: query
name: startDate
description: The earliest mass message to retrieve. Keep empty to get all.
example: 2025-01-01 00:00:00
required: false
schema:
type: string
description: The earliest mass message to retrieve. Keep empty to get all.
example: 2025-01-01 00:00:00
- in: query
name: endDate
description: The latest mass message to retrieve. Keep empty to get all. MUST BE
DATE AFTER `startDate`. This is also used for pagination.
example: 2025-03-31 23:59:59
required: false
schema:
type: string
description: The latest mass message to retrieve. Keep empty to get all. MUST BE
DATE AFTER `startDate`. This is also used for pagination.
example: 2025-03-31 23:59:59
- in: query
name: limit
description: Number of mass messages to return (default = 10)
example: 10
required: false
schema:
type: integer
description: Number of mass messages to return (default = 10)
example: 10
- in: query
name: query
description: Optionally, find a mass message by the message text.
example: My message text
required: false
schema:
type: string
description: Optionally, find a mass message by the message text.
example: My message text
responses:
"200":
description: ""
content:
application/json:
schema:
type: object
example:
data:
hasMore: true
items:
- id: 123
date: 2025-01-01T01:01:01+01:01
responseType: message
text: Text
rawText: Text
giphyId: null
isFree: true
isMediaReady: true
mediaCount: 1
media:
- id: 123
type: photo
convertedToVideo: false
canView: true
hasError: false
createdAt: 2025-01-01T01:01:01+01:01
isReady: true
files:
full:
url: https://cdn2.onlyfans.com/files/.../image.jpg
width: 2335
height: 4175
size: 0
sources: []
thumb:
url: https://cdn2.onlyfans.com/files/.../image.jpg
width: 300
height: 300
size: 0
preview:
url: https://cdn2.onlyfans.com/files/.../image.jpg
width: 960
height: 1717
size: 0
squarePreview:
url: https://cdn2.onlyfans.com/files/.../image.jpg
width: 960
height: 960
size: 0
duration: 0
hasCustomPreview: false
videoSources:
"240": null
"720": null
previews: []
isTip: false
isReportedByMe: false
viewedCount: 123
sentCount: 123
isCanceled: false
template: group
canUnsend: true
unsendSeconds: 1000000
_meta:
_credits:
used: 1
balance: 999999959
note: Always
_cache:
is_cached: false
note: Cache disabled for this endpoint
_rate_limits:
limit_minute: 1000
limit_day: 50000
remaining_minute: 998
remaining_day: 49988
properties:
data:
type: object
properties:
hasMore:
type: boolean
example: true
items:
type: array
example:
- id: 123
date: 2025-01-01T01:01:01+01:01
responseType: message
text: Text
rawText: Text
giphyId: null
isFree: true
isMediaReady: true
mediaCount: 1
media:
- id: 123
type: photo
convertedToVideo: false
canView: true
hasError: false
createdAt: 2025-01-01T01:01:01+01:01
isReady: true
files:
full:
url: https://cdn2.onlyfans.com/files/.../image.jpg
width: 2335
height: 4175
size: 0
sources: []
thumb:
url: https://cdn2.onlyfans.com/files/.../image.jpg
width: 300
height: 300
size: 0
preview:
url: https://cdn2.onlyfans.com/files/.../image.jpg
width: 960
height: 1717
size: 0
squarePreview:
url: https://cdn2.onlyfans.com/files/.../image.jpg
width: 960
height: 960
size: 0
duration: 0
hasCustomPreview: false
videoSources:
"240": null
"720": null
previews: []
isTip: false
isReportedByMe: false
viewedCount: 123
sentCount: 123
isCanceled: false
template: group
canUnsend: true
unsendSeconds: 1000000
items:
type: object
properties:
id:
type: integer
example: 123
date:
type: string
example: 2025-01-01T01:01:01+01:01
responseType:
type: string
example: message
text:
type: string
example: Text
rawText:
type: string
example: Text
giphyId:
type: string
example: null
nullable: true
isFree:
type: boolean
example: true
isMediaReady:
type: boolean
example: true
mediaCount:
type: integer
example: 1
media:
type: array
example:
- id: 123
type: photo
convertedToVideo: false
canView: true
hasError: false
createdAt: 2025-01-01T01:01:01+01:01
isReady: true
files:
full:
url: https://cdn2.onlyfans.com/files/.../image.jpg
width: 2335
height: 4175
size: 0
sources: []
thumb:
url: https://cdn2.onlyfans.com/files/.../image.jpg
width: 300
height: 300
size: 0
preview:
url: https://cdn2.onlyfans.com/files/.../image.jpg
width: 960
height: 1717
size: 0
squarePreview:
url: https://cdn2.onlyfans.com/files/.../image.jpg
width: 960
height: 960
size: 0
duration: 0
hasCustomPreview: false
videoSources:
"240": null
"720": null
items:
type: object
properties:
id:
type: integer
example: 123
type:
type: string
example: photo
convertedToVideo:
type: boolean
example: false
canView:
type: boolean
example: true
hasError:
type: boolean
example: false
createdAt:
type: string
example: 2025-01-01T01:01:01+01:01
isReady:
type: boolean
example: true
files:
type: object
properties:
full:
type: object
properties:
url:
type: string
example: https://cdn2.onlyfans.com/files/.../image.jpg
width:
type: integer
example: 2335
height:
type: integer
example: 4175
size:
type: integer
example: 0
sources:
type: array
example: []
thumb:
type: object
properties:
url:
type: string
example: https://cdn2.onlyfans.com/files/.../image.jpg
width:
type: integer
example: 300
height:
type: integer
example: 300
size:
type: integer
example: 0
preview:
type: object
properties:
url:
type: string
example: https://cdn2.onlyfans.com/files/.../image.jpg
width:
type: integer
example: 960
height:
type: integer
example: 1717
size:
type: integer
example: 0
squarePreview:
type: object
properties:
url:
type: string
example: https://cdn2.onlyfans.com/files/.../image.jpg
width:
type: integer
example: 960
height:
type: integer
example: 960
size:
type: integer
example: 0
duration:
type: integer
example: 0
hasCustomPreview:
type: boolean
example: false
videoSources:
type: object
properties:
"240":
type: string
example: null
nullable: true
"720":
type: string
example: null
nullable: true
previews:
type: array
example: []
isTip:
type: boolean
example: false
isReportedByMe:
type: boolean
example: false
viewedCount:
type: integer
example: 123
sentCount:
type: integer
example: 123
isCanceled:
type: boolean
example: false
template:
type: string
example: group
canUnsend:
type: boolean
example: true
unsendSeconds:
type: integer
example: 1000000
_meta:
type: object
properties:
_credits:
type: object
properties:
used:
type: integer
example: 1
balance:
type: integer
example: 999999959
note:
type: string
example: Always
_cache:
type: object
properties:
is_cached:
type: boolean
example: false
note:
type: string
example: Cache disabled for this endpoint
_rate_limits:
type: object
properties:
limit_minute:
type: integer
example: 1000
limit_day:
type: integer
example: 50000
remaining_minute:
type: integer
example: 998
remaining_day:
type: integer
example: 49988
tags:
- Mass Messaging
components:
securitySchemes:
default:
type: http
scheme: bearer
description: Get your API Key from OnlyFansAPI Console -
https://app.onlyfansapi.com/api-keys
````