TikTok Live Ranking List (by Room + Anchor ID)

{
  "type": "object",
  "required": [
    "room_id",
    "anchor_id"
  ],
  "properties": {
    "room_id": {
      "type": "string",
      "examples": [
        "7358603858249009962"
      ],
      "description": "Live room id"
    },
    "anchor_id": {
      "type": "string",
      "examples": [
        "7222941468722758702"
      ],
      "description": "Anchor id"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "ranks": {
          "type": "array",
          "description": "The ranked entries. Observed as an empty array `[]` on the one resolvable-room fixture calibrated (the room wasn't live at capture time) -- the shape of a populated entry is unconfirmed."
        },
        "total": {
          "type": "number",
          "description": "Count of ranked entries; observed as 0."
        },
        "message": {
          "type": "string",
          "description": "Present only in the invalid-input shape, e.g. 'Service internal error' for a room_id/anchor_id pair that doesn't resolve."
        },
        "prompts": {
          "type": "string",
          "description": "Same text as `message` in the one invalid-input case observed."
        },
        "currency": {
          "type": "string",
          "description": "e.g. 'Coins', the virtual-gift currency label."
        },
        "rule_url": {
          "type": [
            "string",
            "null"
          ],
          "description": "A link to the ranking rules. Value withheld (returned as `null` regardless of what the endpoint published) -- only whether the field is populated is observable, not the destination itself."
        },
        "sub_tabs": {
          "type": "array",
          "description": "Sub-tabs of the ranking panel (e.g. daily/weekly views). Observed empty on the one resolvable-room fixture calibrated; a populated entry's shape is unconfirmed."
        },
        "anonymous": {
          "type": "number",
          "description": "Observed as the number 0; appears to be a flag rather than a count, exact meaning unconfirmed from the one fixture calibrated."
        },
        "deprecated": {
          "type": "boolean"
        },
        "bottom_notice": {
          "type": "string",
          "description": "Footer text shown under the ranking list."
        },
        "preview_count": {
          "type": "number"
        },
        "display_config": {
          "type": "object",
          "properties": {
            "show_score": {
              "type": "boolean"
            },
            "avatar_count": {
              "type": "number"
            },
            "can_panel_click": {
              "type": "boolean"
            },
            "show_avatar_list": {
              "type": "boolean"
            },
            "show_online_panel": {
              "type": "boolean"
            }
          },
          "description": "Which UI elements the ranking panel should show.",
          "additionalProperties": true
        },
        "anchor_show_contribution": {
          "type": "boolean",
          "description": "Whether the anchor's own contribution is shown in the ranking panel."
        }
      },
      "description": "Either the ranking payload or the invalid-input error shape (message/prompts) -- which keys appear depends on whether room_id/anchor_id resolves to a real room.",
      "additionalProperties": true
    },
    "extra": {
      "type": "object",
      "properties": {
        "now": {
          "type": "number",
          "description": "Server-side unix-millisecond timestamp of the response."
        }
      },
      "additionalProperties": true
    },
    "status_code": {
      "type": "number",
      "description": "0 on the resolvable-room fixture; a nonzero code (10002 observed) on the invalid-room fixture, alongside data.message/data.prompts."
    }
  },
  "description": "The ranking-lookup record, as returned at routing.responseResultPath ($.output). Two shapes observed for `data`: the ranking payload (ranks/total/display_config/etc, present even when the ranks list is empty) for a resolvable room_id/anchor_id pair, or a short message/prompts pair for an invalid one -- confirmed against both real fixtures.",
  "additionalProperties": true
}