> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ofauth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Top message stats

> Get top message stats for the linked account.

**Required scope:** `analytics:read`



## OpenAPI

````yaml /openapi/v3.json get /v3/access/analytics/profile/top/messages
openapi: 3.1.0
info:
  title: OFAuth API
  version: 1.0.0
  description: >-
    OFAuth V3 API for linking accounts, making OnlyFans API requests, and
    receiving events.
  contact:
    email: support@ofauth.com
    url: https://ofauth.com/
servers:
  - url: https://api.ofauth.com
security:
  - ExternalOAuth: []
tags:
  - name: Link
    description: Link accounts, get and refresh tokens, and end access.
  - name: Linked accounts
    description: The linked accounts of one authorization, and their settings.
  - name: Access
    description: Make OnlyFans API requests for a linked account.
  - name: Analytics
    description: 'Access: charts, rankings, and performance data.'
  - name: Earnings
    description: 'Access: earnings charts, transactions, and chargebacks.'
  - name: Messages
    description: 'Access: messaging, chats, queue, and mass messaging.'
  - name: Posts
    description: 'Access: create, edit, list, and manage posts.'
  - name: Promotions
    description: 'Access: promotions, trials, and bundles.'
  - name: Users
    description: 'Access: user profiles, subscriptions, and actions.'
  - name: Vault
    description: 'Access: vault folders, media, and management.'
  - name: Upload
    description: 'Access: media upload and processing.'
  - name: Self
    description: 'Access: linked account profile and settings.'
  - name: Stories
    description: 'Access: stories listing and management.'
  - name: Subscriptions
    description: 'Access: subscription offers, discounts, and management.'
  - name: Realtime
    description: Webhook event formats, including OnlyFans activity events.
externalDocs:
  description: OFAuth Developer Documentation
  url: https://docs.ofauth.com
paths:
  /v3/access/analytics/profile/top/messages:
    get:
      tags:
        - Analytics
      summary: Top message stats
      description: |-
        Get top message stats for the linked account.

        **Required scope:** `analytics:read`
      operationId: access.analytics.profile.top.getMessages
      parameters:
        - name: x-linked-account-id
          in: header
          required: true
          description: >-
            The linked account to use. The user must have shared it with your
            app. A missing account returns `linked_account_required`; an account
            outside your access returns `linked_account_not_granted`.
          schema:
            type: string
            example: conn_example123
        - schema:
            type: string
            description: Start date. Keep this date when requesting older results.
          required: false
          description: Start date. Keep this date when requesting older results.
          name: startDate
          in: query
        - schema:
            type: string
            description: End date. Use an earlier date to request older results.
          required: false
          description: End date. Use an earlier date to request older results.
          name: endDate
          in: query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  purchases:
                    type: object
                    properties:
                      canSendMessageToBuyers:
                        type: boolean
                      canUnsend:
                        type: boolean
                      date:
                        type: string
                      giphyId:
                        type: 'null'
                      id:
                        type: number
                      isCanceled:
                        type: boolean
                      isFree:
                        type: boolean
                      isMediaReady:
                        type: boolean
                      isReportedByMe:
                        type: boolean
                      isTip:
                        type: boolean
                      media:
                        type: array
                        items:
                          type: object
                          properties:
                            canView:
                              type: boolean
                            convertedToVideo:
                              type: boolean
                            createdAt:
                              type: string
                            duration:
                              type: number
                            files:
                              type: object
                              properties:
                                full:
                                  type: object
                                  properties:
                                    height:
                                      type: number
                                    size:
                                      type: number
                                    sources:
                                      type: array
                                      items: {}
                                    url:
                                      type: string
                                    width:
                                      type: number
                                  additionalProperties: true
                                  required:
                                    - height
                                    - size
                                    - sources
                                    - url
                                    - width
                                preview:
                                  type: object
                                  properties:
                                    height:
                                      type: number
                                    size:
                                      type: number
                                    url:
                                      type: string
                                    width:
                                      type: number
                                  additionalProperties: true
                                  required:
                                    - height
                                    - size
                                    - url
                                    - width
                                squarePreview:
                                  type: object
                                  properties:
                                    height:
                                      type: number
                                    size:
                                      type: number
                                    url:
                                      type: string
                                    width:
                                      type: number
                                  additionalProperties: true
                                  required:
                                    - height
                                    - size
                                    - url
                                    - width
                                thumb:
                                  type: object
                                  properties:
                                    height:
                                      type: number
                                    size:
                                      type: number
                                    url:
                                      type: string
                                    width:
                                      type: number
                                  additionalProperties: true
                                  required:
                                    - height
                                    - size
                                    - url
                                    - width
                              additionalProperties: true
                              required:
                                - full
                                - preview
                                - squarePreview
                                - thumb
                            hasCustomPreview:
                              type: boolean
                            hasError:
                              type: boolean
                            id:
                              type: number
                            isReady:
                              type: boolean
                            type:
                              type: string
                            videoSources:
                              type: object
                              properties:
                                '240':
                                  anyOf:
                                    - type: 'null'
                                    - type: string
                                '720':
                                  anyOf:
                                    - type: 'null'
                                    - type: string
                              additionalProperties: true
                              required:
                                - '240'
                                - '720'
                          additionalProperties: true
                          required:
                            - canView
                            - convertedToVideo
                            - createdAt
                            - duration
                            - files
                            - hasCustomPreview
                            - hasError
                            - id
                            - isReady
                            - type
                            - videoSources
                      mediaCount:
                        type: number
                      previews:
                        type: array
                        items:
                          type: number
                      price:
                        type: string
                      purchasedCount:
                        type: number
                      rawText:
                        type: string
                      responseType:
                        type: string
                      sentCount:
                        type: number
                      template:
                        type: string
                      text:
                        type: string
                      unsendSeconds:
                        type: number
                      viewedCount:
                        type: number
                    additionalProperties: true
                    required:
                      - canSendMessageToBuyers
                      - canUnsend
                      - date
                      - giphyId
                      - id
                      - isCanceled
                      - isFree
                      - isMediaReady
                      - isReportedByMe
                      - isTip
                      - media
                      - mediaCount
                      - previews
                      - price
                      - purchasedCount
                      - rawText
                      - responseType
                      - sentCount
                      - template
                      - text
                      - unsendSeconds
                      - viewedCount
                additionalProperties: true
                required:
                  - purchases
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: Rate Limit Exceeded
        '500':
          description: Internal Server Error
        '502':
          description: Bad Gateway
      deprecated: false
      security:
        - ExternalOAuth: []
          LinkedAccountId: []
components:
  securitySchemes:
    ExternalOAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: Link access token for one Sandbox, Test, or Live authorization.
    LinkedAccountId:
      type: apiKey
      name: x-linked-account-id
      in: header
      description: >-
        Selects one of the authorization's linked accounts via the
        x-linked-account-id header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.