Skip to main content
GET
/
v2
/
access
/
analytics
/
stories
/
top
Top stories
curl --request GET \
  --url https://api-next.ofauth.com/v2/access/analytics/stories/top \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'
{
  "hasMore": true,
  "items": [
    {
      "id": 123,
      "userId": 123,
      "isReady": true,
      "hasPost": true,
      "isWatched": true,
      "media": [
        {
          "id": 123,
          "type": "photo",
          "convertedToVideo": true,
          "canView": true,
          "hasError": true,
          "createdAt": "<string>",
          "isReady": true,
          "releaseForms": [
            {
              "id": 123,
              "name": "<string>",
              "partnerSource": "<string>",
              "type": "<string>",
              "user": {
                "view": "<string>",
                "id": 123,
                "name": "<string>",
                "username": "<string>",
                "isVerified": true,
                "avatar": "<string>",
                "avatarThumbs": {
                  "c50": "<string>",
                  "c144": "<string>"
                },
                "ivStatus": "<string>",
                "isFromGuest": true
              }
            }
          ],
          "duration": 123,
          "hasCustomPreview": true,
          "videoSources": {
            "240": "<string>",
            "720": "<string>"
          },
          "files": {
            "full": {
              "url": "<string>",
              "sources": [
                {
                  "url": "<string>",
                  "width": 123,
                  "height": 123,
                  "type": "<string>"
                }
              ],
              "width": 123,
              "height": 123,
              "size": 123
            },
            "thumb": {
              "url": "<string>",
              "width": 123,
              "height": 123,
              "size": 123
            },
            "preview": {
              "url": "<string>",
              "options": [
                {
                  "url": "<string>",
                  "width": 123,
                  "height": 123,
                  "type": "<string>"
                }
              ],
              "width": 123,
              "height": 123,
              "size": 123
            },
            "squarePreview": {
              "url": "<string>",
              "width": 123,
              "height": 123,
              "size": 123
            }
          }
        }
      ],
      "createdAt": "<string>",
      "canvasHeight": 123,
      "canvasWidth": 123,
      "viewersCount": 123,
      "viewers": [
        {
          "id": 123,
          "name": "<string>",
          "username": "<string>",
          "avatar": "<string>",
          "avatarThumbs": {
            "c50": "<string>",
            "c144": "<string>"
          },
          "isVerified": true,
          "canLookStory": true,
          "canCommentStory": true,
          "hasNotViewedStory": true,
          "isStoryLiked": true,
          "isStoryBlockedUser": true
        }
      ],
      "commentsCount": 123,
      "canDelete": true,
      "isHighlightCover": true,
      "isLastInHighlight": true,
      "tipsAmount": "<string>",
      "tipsAmountRaw": 123,
      "tipsCount": 123,
      "likesCount": 123,
      "releaseForms": [
        {
          "id": 123,
          "name": "<string>",
          "partnerSource": "<string>",
          "type": "<string>",
          "user": {
            "view": "<string>",
            "id": 123,
            "name": "<string>",
            "username": "<string>",
            "isVerified": true,
            "avatar": "<string>",
            "avatarThumbs": {
              "c50": "<string>",
              "c144": "<string>"
            },
            "ivStatus": "<string>",
            "isFromGuest": true
          }
        }
      ],
      "texts": [
        {
          "text": "<string>",
          "position": {
            "x": 123,
            "y": 123,
            "width": 123,
            "height": 123,
            "angle": 123
          }
        }
      ],
      "question": {
        "entity": {
          "id": 123,
          "text": "<string>",
          "createdAt": "<string>"
        },
        "type": "<string>",
        "positions": {
          "zIndex": 123,
          "x": 123,
          "y": 123,
          "top": 123,
          "left": 123,
          "width": 123,
          "height": 123,
          "angle": 123,
          "color": "<string>"
        }
      },
      "post": {
        "id": 123,
        "author": {
          "id": 123,
          "_view": "<string>"
        },
        "coordinateParams": {
          "top": 123,
          "left": 123,
          "angle": 123,
          "scale": 123,
          "width": 123,
          "height": 123
        }
      }
    }
  ]
}

Authorizations

apiKey
string
header
required

Your OFAuth API key for authenticating requests.

x-connection-id
string
header
required

Requires a connection via the x-connection-id header.

Query Parameters

by
enum<string>

Metric to rank by

Available options:
tips,
views,
likes,
comments
startDate

Start of date range (ISO 8601)

endDate

End of date range (ISO 8601)

limit
integer
default:20

Number of items to return (1-20, default: 20)

Required range: 1 <= x <= 20
offset
integer | null
default:0

Number of items to skip (default: 0)

Required range: x >= 0

Response

Successful response

hasMore
boolean
required
items
object[]
required