Get Live Room User Portraits

GET

/analytics/202502/live_rooms/{live_room_id}/user_portraits

Returns user portrait indicators for the specified live room, including age, gender, fan, advertisement, and region distributions.

Authorizations

• accessToken

Parameters

Path Parameters

live_room_id

required

string

The ID of the live stream room whose user portrait indicators are requested.

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

all_ads_gender_indicators

Gender indicators for advertisement

Array<object>

object

type

The gender category represented by this indicator. Possible values:

• USER_PORTRAIT_GENDER_UNKNOWN: Unknown gender.
• USER_PORTRAIT_GENDER_M: Male.
• USER_PORTRAIT_GENDER_F: Female.

string

Allowed values: USER_PORTRAIT_GENDER_UNKNOWN USER_PORTRAIT_GENDER_M USER_PORTRAIT_GENDER_F

value

The count for the corresponding gender indicator.

string

all_fan_indicators

Fans indicators

Array<object>

object

type

The stats_type describes the type of value below.

USER_PORTRAIT_FOLLOWER: The user portrait of the follower

USER_PORTRAIT_NON_FOLLOWER: The user portrait of the non follower

string

value

The count for the corresponding follower-status indicator.

string

all_ads_age_indicators

Age indicators for advertisement

Array<object>

object

type

The type of age indicator. USER_PORTRAIT_AGE_LESS_THAN_15: Users whose age is less than 15. USER_PORTRAIT_AGE_MORE_THAN_34: Users whose age is more than 34. USER_PORTRAIT_AGE_MORE_THAN_55: Users whose age is more than 55. USER_PORTRAIT_AGE_13_TO_17: Users whose age is between 13 and 17. USER_PORTRAIT_AGE_15_TO_17: Users whose age is between 15 and 17. USER_PORTRAIT_AGE_18_TO_24: Users whose age is between 18 and 24. USER_PORTRAIT_AGE_25_TO_34: Users whose age is between 25 and 34. USER_PORTRAIT_AGE_35_TO_44: Users whose age is between 35 and 44. USER_PORTRAIT_AGE_45_TO_54: Users whose age is between 45 and 54.

string

value

The count for the corresponding age indicator.

string

region_indicators

Country-level user portrait indicators for the live room.

Array<object>

object

value

The share for the corresponding indicator, scaled by 10,000. Divide by 10,000 to obtain the underlying proportion.

string

type

The country of indicators

string

paid_ads_age_indicators

Paid advertisement age indicators for advertisement

Array<object>

object

type

The type of paid advertisement age indicator. USER_PORTRAIT_AGE_LESS_THAN_15: Users whose age is less than 15. USER_PORTRAIT_AGE_MORE_THAN_34: Users whose age is more than 34. USER_PORTRAIT_AGE_MORE_THAN_55: Users whose age is more than 55. USER_PORTRAIT_AGE_13_TO_17: Users whose age is between 13 and 17. USER_PORTRAIT_AGE_15_TO_17: Users whose age is between 15 and 17. USER_PORTRAIT_AGE_18_TO_24: Users whose age is between 18 and 24. USER_PORTRAIT_AGE_25_TO_34: Users whose age is between 25 and 34. USER_PORTRAIT_AGE_35_TO_44: Users whose age is between 35 and 44. USER_PORTRAIT_AGE_45_TO_54: Users whose age is between 45 and 54.

string

value

The count for the corresponding paid-advertising age indicator.

string

paid_ads_gender_indicators

Paid advertisement gender indicators for advertisement

Array<object>

object

type

The gender category represented by this indicator. Possible values:

• USER_PORTRAIT_GENDER_UNKNOWN: Unknown gender.
• USER_PORTRAIT_GENDER_M: Male.
• USER_PORTRAIT_GENDER_F: Female.

string

Allowed values: USER_PORTRAIT_GENDER_UNKNOWN USER_PORTRAIT_GENDER_M USER_PORTRAIT_GENDER_F

value

The count for the corresponding paid-advertising gender indicator.

string

paid_fan_indicators

Paid fans indicators

Array<object>

object

type

The stats_type describes the type of value below.

USER_PORTRAIT_FOLLOWER: The user portrait of the follower

USER_PORTRAIT_NON_FOLLOWER: The user portrait of the non follower

string

value

The count for the corresponding paid follower-status indicator.

string

Example

{
  "code": 0,
  "data": {
    "all_ads_gender_indicators": [
      {
        "type": "USER_PORTRAIT_GENDER_UNKNOWN",
        "value": "123"
      }
    ],
    "all_fan_indicators": [
      {
        "type": "USER_PORTRAIT_FOLLOWER",
        "value": "123"
      }
    ],
    "all_ads_age_indicators": [
      {
        "type": "USER_PORTRAIT_AGE_LESS_THAN_15",
        "value": "123"
      }
    ],
    "region_indicators": [
      {
        "value": "123",
        "type": "ID"
      }
    ],
    "paid_ads_age_indicators": [
      {
        "type": "USER_PORTRAIT_AGE_LESS_THAN_15",
        "value": "123"
      }
    ],
    "paid_ads_gender_indicators": [
      {
        "type": "USER_PORTRAIT_GENDER_UNKNOWN",
        "value": "123"
      }
    ],
    "paid_fan_indicators": [
      {
        "type": "USER_PORTRAIT_FOLLOWER",
        "value": "123"
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}