Kol analytics

Get KOL table

Retrieve Key Opinion Leader (KOL) analytics.

GET
/v2/x-users/analytics
AuthorizationBasic <token>

In: header

Query Parameters

offset?number

Number of items to skip for pagination

Default0
Range0 <= value
limit?number

Number of items to return (max 100)

Default20
Range1 <= value <= 100
labels?array<string>
sortField?string

Field to sort by

Default"totalScore"
Value in"totalToken" | "smFollower" | "mention" | "impression" | "sScore" | "aScore" | "lScore" | "eScore" | "totalScore" | "scoreV2" | "activeScore" | "winrate" | "rugRate" | "loseRate" | "userRanking"
sortOrder?string

Sort order (ascending or descending)

Default"DESC"
Value in"ASC" | "DESC"
last24hMention?boolean
search?string

Search by KOL username or display name (partial, case-insensitive)

minTotalToken?string
maxTotalToken?string
minSmFollower?string
maxSmFollower?string
minMention?string
maxMention?string
minImpression?string
maxImpression?string
minWinrate?string
maxWinrate?string
minRugRate?string
maxRugRate?string
minLoseRate?string
maxLoseRate?string
minScoreV2?string
maxScoreV2?string
minActiveScore?string
maxActiveScore?string

Response Body

application/json

application/json

application/json

curl -X GET "https://api-business.nerox.ai/v2/x-users/analytics"
{
  "type": {},
  "items": [
    {
      "id": 84715,
      "kol": "aixuexi_ai",
      "display_name": "Engineer_AI",
      "avatar": "https://cdn.nerox.ai/uploads/x-avatars/2006345746145054720/C5vyl_qC_400x400.jpg",
      "total_token": 1,
      "sm_follower": 639,
      "mention": 0,
      "impression": 0,
      "s_score": 5,
      "a_score": 4,
      "l_score": 5,
      "e_score": 1,
      "total_score": 3.75,
      "score_v2": 3.7260473663549782,
      "active_score": 1.1066126855600542,
      "winrate": 0,
      "rug_rate": 1,
      "lose_rate": 1,
      "user_ranking": 1,
      "checkmark_type": 1,
      "labels": [
        "1"
      ]
    }
  ],
  "total": 3949,
  "meta": {
    "limit": 1,
    "offset": 0
  }
}
{
  "statusCode": 400,
  "message": "Bad Request",
  "error": "Bad Request"
}
{
  "statusCode": 401,
  "message": "Unauthorized",
  "error": "Unauthorized"
}

Last updated on