> ## 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 stories

> Get top performing stories

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



## OpenAPI

````yaml /openapi/v3.json get /v3/access/analytics/stories/top
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/stories/top:
    get:
      tags:
        - Analytics
      summary: Top stories
      description: |-
        Get top performing stories

        **Required scope:** `analytics:read`
      operationId: access.analytics.stories.listTop
      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
            enum:
              - tips
              - views
            description: Metric to rank by
          required: false
          description: Metric to rank by
          name: by
          in: query
        - schema:
            anyOf:
              - type: string
                nullable: true
              - type: string
                description: Date in ISO 8601 format
              - nullable: true
            description: >-
              Start date in ISO 8601 format. Keep this date when requesting
              older results.
          required: false
          description: >-
            Start date in ISO 8601 format. Keep this date when requesting older
            results.
          name: startDate
          in: query
        - schema:
            anyOf:
              - type: string
                nullable: true
              - type: string
                description: Date in ISO 8601 format
              - nullable: true
            description: >-
              End date in ISO 8601 format. Use an earlier date to request older
              results.
          required: false
          description: >-
            End date in ISO 8601 format. Use an earlier date to request older
            results.
          name: endDate
          in: query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        userId:
                          type: number
                        isReady:
                          type: boolean
                        hasPost:
                          type: boolean
                        isWatched:
                          type: boolean
                        media:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: number
                              type:
                                type: string
                                enum:
                                  - photo
                                  - video
                                  - gif
                                  - audio
                              convertedToVideo:
                                type: boolean
                              canView:
                                type: boolean
                              hasError:
                                type: boolean
                              createdAt:
                                type: string
                              isReady:
                                type: boolean
                              duration:
                                type: number
                              releaseForms:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: number
                                    name:
                                      type: string
                                    partnerSource:
                                      type: string
                                    type:
                                      type: string
                                    user:
                                      type: object
                                      properties:
                                        id:
                                          type: number
                                        name:
                                          type: string
                                        username:
                                          type: string
                                        displayName:
                                          type: string
                                          nullable: true
                                        isVerified:
                                          type: boolean
                                        avatar:
                                          type: string
                                          nullable: true
                                        avatarThumbs:
                                          type: object
                                          nullable: true
                                          additionalProperties:
                                            type: string
                                        ivStatus:
                                          type: string
                                        isFromGuest:
                                          type: boolean
                                      required:
                                        - id
                                        - name
                                        - username
                                  required:
                                    - id
                                    - name
                                    - partnerSource
                                    - type
                              hasCustomPreview:
                                type: boolean
                              videoSources:
                                type: object
                                properties:
                                  '240':
                                    type: string
                                    nullable: true
                                  '720':
                                    type: string
                                    nullable: true
                              files:
                                type: object
                                properties:
                                  full:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                      width:
                                        type: number
                                      height:
                                        type: number
                                      size:
                                        type: number
                                      sources:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            url:
                                              type: string
                                            width:
                                              type: number
                                            height:
                                              type: number
                                            type:
                                              type: string
                                          required:
                                            - url
                                    required:
                                      - url
                                      - sources
                                  thumb:
                                    type: object
                                    nullable: true
                                    properties:
                                      url:
                                        type: string
                                      width:
                                        type: number
                                      height:
                                        type: number
                                      size:
                                        type: number
                                    required:
                                      - url
                                  preview:
                                    anyOf:
                                      - type: object
                                        properties:
                                          url:
                                            type: string
                                          width:
                                            type: number
                                          height:
                                            type: number
                                          size:
                                            type: number
                                          options:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                url:
                                                  type: string
                                                width:
                                                  type: number
                                                height:
                                                  type: number
                                                type:
                                                  type: string
                                              required:
                                                - url
                                        required:
                                          - url
                                          - options
                                      - type: object
                                        properties:
                                          url:
                                            type: string
                                          width:
                                            type: number
                                          height:
                                            type: number
                                          size:
                                            type: number
                                        required:
                                          - url
                                      - nullable: true
                                  squarePreview:
                                    type: object
                                    nullable: true
                                    properties:
                                      url:
                                        type: string
                                      width:
                                        type: number
                                      height:
                                        type: number
                                      size:
                                        type: number
                                    required:
                                      - url
                                required:
                                  - full
                            required:
                              - id
                              - type
                              - convertedToVideo
                              - canView
                              - hasError
                              - createdAt
                              - isReady
                        createdAt:
                          type: string
                        canvasHeight:
                          type: number
                        canvasWidth:
                          type: number
                        question:
                          type: object
                          properties:
                            entity:
                              type: object
                              properties:
                                id:
                                  type: number
                                text:
                                  type: string
                                createdAt:
                                  type: string
                              required:
                                - id
                                - text
                                - createdAt
                            type:
                              type: string
                            positions:
                              type: object
                              properties:
                                zIndex:
                                  type: number
                                x:
                                  type: number
                                  nullable: true
                                'y':
                                  type: number
                                  nullable: true
                                top:
                                  type: number
                                left:
                                  type: number
                                width:
                                  type: number
                                height:
                                  type: number
                                angle:
                                  type: number
                                color:
                                  type: string
                              required:
                                - zIndex
                                - x
                                - 'y'
                                - top
                                - left
                                - width
                                - height
                                - angle
                                - color
                          required:
                            - entity
                            - type
                            - positions
                        viewersCount:
                          type: number
                        viewers:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: number
                              username:
                                type: string
                              name:
                                type: string
                              displayName:
                                type: string
                                nullable: true
                              isVerified:
                                type: boolean
                              avatar:
                                type: string
                                nullable: true
                              avatarThumbs:
                                type: object
                                nullable: true
                                additionalProperties:
                                  type: string
                              canLookStory:
                                type: boolean
                              canCommentStory:
                                type: boolean
                              hasNotViewedStory:
                                type: boolean
                              isStoryLiked:
                                type: boolean
                              isStoryBlockedUser:
                                type: boolean
                            required:
                              - id
                              - username
                              - name
                              - isVerified
                              - canLookStory
                              - canCommentStory
                              - hasNotViewedStory
                              - isStoryLiked
                              - isStoryBlockedUser
                        commentsCount:
                          type: number
                        canDelete:
                          type: boolean
                        isHighlightCover:
                          type: boolean
                        isLastInHighlight:
                          type: boolean
                        tipsAmount:
                          type: string
                        tipsAmountRaw:
                          type: number
                        tipsCount:
                          type: number
                        likesCount:
                          type: number
                        releaseForms:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: number
                              name:
                                type: string
                              partnerSource:
                                type: string
                              type:
                                type: string
                              user:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  name:
                                    type: string
                                  username:
                                    type: string
                                  displayName:
                                    type: string
                                    nullable: true
                                  isVerified:
                                    type: boolean
                                  avatar:
                                    type: string
                                    nullable: true
                                  avatarThumbs:
                                    type: object
                                    nullable: true
                                    additionalProperties:
                                      type: string
                                  ivStatus:
                                    type: string
                                  isFromGuest:
                                    type: boolean
                                required:
                                  - id
                                  - name
                                  - username
                            required:
                              - id
                              - name
                              - partnerSource
                              - type
                        post:
                          type: object
                          properties:
                            id:
                              type: number
                            author:
                              type: object
                              properties:
                                id:
                                  type: number
                                username:
                                  type: string
                                  nullable: true
                                name:
                                  type: string
                                  nullable: true
                                displayName:
                                  type: string
                                  nullable: true
                                isVerified:
                                  type: boolean
                                  nullable: true
                                avatar:
                                  type: string
                                  nullable: true
                                avatarThumbs:
                                  type: object
                                  nullable: true
                                  additionalProperties:
                                    type: string
                              required:
                                - id
                            coordinateParams:
                              type: object
                              properties:
                                top:
                                  type: number
                                left:
                                  type: number
                                angle:
                                  type: number
                                scale:
                                  type: number
                                width:
                                  type: number
                                height:
                                  type: number
                              required:
                                - top
                                - left
                                - angle
                                - scale
                                - width
                                - height
                          required:
                            - id
                        texts:
                          type: array
                          items:
                            type: object
                            properties:
                              text:
                                type: string
                              position:
                                type: object
                                properties:
                                  x:
                                    type: number
                                  'y':
                                    type: number
                                  width:
                                    type: number
                                  height:
                                    type: number
                                  angle:
                                    type: number
                                required:
                                  - x
                                  - 'y'
                                  - width
                                  - height
                                  - angle
                            required:
                              - text
                              - position
                      required:
                        - id
                        - userId
                        - isReady
                        - hasPost
                        - isWatched
                        - media
                        - createdAt
                        - canvasHeight
                        - canvasWidth
                        - viewersCount
                        - viewers
                        - commentsCount
                        - canDelete
                        - isHighlightCover
                        - isLastInHighlight
                        - tipsAmount
                        - tipsAmountRaw
                        - tipsCount
                        - likesCount
                        - releaseForms
                        - texts
                required:
                  - items
                additionalProperties: false
        '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.