Skip to main content
GET
/
v2
/
access
/
analytics
/
streams
/
top
Top streams
curl --request GET \
  --url https://api-next.ofauth.com/v2/access/analytics/streams/top \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'
{
  "hasMore": true,
  "items": [
    {
      "id": 123,
      "canDelete": true,
      "canEdit": true,
      "mediaCount": 123,
      "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
            }
          }
        }
      ],
      "canViewMedia": true,
      "responseType": "<string>",
      "postedAt": "<string>",
      "postedAtPrecise": "<string>",
      "isMarkdownDisabled": true,
      "isOpened": true,
      "canToggleFavorite": true,
      "tipsAmount": "<string>",
      "text": "<string>",
      "isFavorite": true,
      "canComment": true,
      "favoritesCount": 123,
      "isMediaReady": true,
      "rawText": "<string>",
      "author": {
        "id": 123,
        "_view": "<string>"
      },
      "stats": {
        "isAvailable": true,
        "hasStats": true,
        "lookCount": 123,
        "uniqueLookCount": 123,
        "uniqueLookChart": [
          {
            "date": "<string>",
            "count": 123
          }
        ],
        "lookChart": [
          {
            "date": "<string>",
            "count": 123
          }
        ],
        "lookDuration": 123,
        "lookDurationAverage": 123,
        "likeCount": 123,
        "likeChart": [
          {
            "date": "<string>",
            "count": 123
          }
        ],
        "commentCount": 123,
        "commentChart": [
          {
            "date": "<string>",
            "count": 123
          }
        ],
        "tipCount": 123,
        "tipChart": [
          {
            "date": "<string>",
            "count": 123
          }
        ],
        "tipSum": 123,
        "purchasedCount": 123,
        "purchasedSumm": 123,
        "hasVideo": true
      }
    }
  ]
}

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:
purchases,
duration,
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