Object
LiveStreamer object
A streamer's live figures over a period, as a live board or a creator marketplace shows them: rank, sessions, viewers and sales bands. The same fields on every platform. A field a platform does not show is null, and meta.unavailable names it with the reason.
| Field | Type | From view | Description |
|---|---|---|---|
id | string | compact | The streamer's ID on the board's source: the Xingtu creator ID on Douyin (what douyin.live.streamers.metrics takes), the user ID on TikTok. |
url | string | null | compact | The streamer's page, where there is one. |
username | string | null | compact | Handle, where the board gives one. |
name | string | null | compact | Display name; null where the source gives none (douyin.live.streamers.metrics). |
avatar_url | string | null | standard | Avatar image URL. |
followers | integer | null | compact | Followers. |
rank | integer | null | compact | Place on the board, from 1; null outside boards. |
score | number | null | standard | The board's score: TikTok's points, or Xingtu's score from 0 to 1. |
category | string | null | compact | Content or product category, in the platform's words. |
room_id | string | null | standard | The room the streamer is live in now, where the board gives it. |
days | integer | null | compact | Days the figures cover; null when the board does not say. |
sessions | integer | null | compact | Live sessions in the period. |
avg_views | integer | null | compact | Average views a session. |
avg_unique_viewers | integer | null | standard | Average people who watched a session. |
avg_viewers | integer | null | compact | Average people watching at once. |
peak_viewers | integer | null | standard | Most people watching at once. |
avg_watch_seconds | integer | null | standard | Average seconds a viewer stayed. |
new_followers | integer | null | compact | Followers gained live in the period. |
engagement_rate | Band | null | standard | Engagement rate as the platform works it out, 0 to 1, as a band. |
gmv | Band | null | compact | Sales over the period, in yuan, as a band. |
avg_gmv | Band | null | compact | Average sales a session, in yuan, as a band. |
gpm | Band | null | standard | Sales per thousand views (GPM), in yuan, as a band. |
avg_price | Band | null | standard | Average price of the products sold, in yuan, as a band. |
products | integer | null | compact | Products sold live in the period. |
ext | object | full | Platform-specific extras. Only returned with view=full. · only with view=full |
Band
| Field | Type | Description |
|---|---|---|
min | number | null | Low end of the band; null when open-ended ("< 400"). |
max | number | null | High end of the band; null when open-ended ("> 0.95"). |