Get Live Room User Portraits

资料正文

§1 Path: /analytics/202502/live_rooms/{live_room_id}/user_portraits

§2 Method: [GET]

§3 Function Description

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

§4 Common Parameters

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

Properties	Location	Type	Require	Sample	Properties description
content-type	header	string	Y	application/json	Allowed type: application/json

§5 Request Path Parameters

Properties	Type	Require	Sample	Properties description
live_room_id	string	Y	7274599999999999999	The ID of the live stream room whose user portrait indicators are requested.

§6 Request Query Parameters

Properties	Type	Require	Sample	Properties description
app_key	string	Y	38abcd	Every single app will have a unique key. Please use the specific key assigned to your app.
sign	string	Y	5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c	Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp	int	Y	1623812664	Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.

§7 Request Sample

Query

https://open-api.tiktokglobalshop.com/analytics/202502/live_rooms/7274599999999999999/user_portraits?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268

§8 Response Parameters

Properties	Type	Sample	Properties description
code	int	0	The success or failure status code returned in API response.
message	string	Success	The success or failure messages returned in API response. Reasons of failure will be described in the message.
request_id	string	202203070749000101890810281E8C70B7	Request log
data	object		Specific return information
^all_ads_gender_indicators	[]object		Gender indicators for advertisement
^^type	string	USER_PORTRAIT_GENDER_UNKNOWN	The stats_type describes the type of value below.

USER_PORTRAIT_GENDER_UNKNOWN: The user portrait of the unknown gender USER_PORTRAIT_GENDER_M: The user portrait of the man USER_PORTRAIT_GENDER_F: The user portrait of the female | ^^value |string |123 |The number of type | ^all_fan_indicators |[]object | |Fans indicators | ^^type |string |USER_PORTRAIT_FOLLOWER |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 | ^^value |string |123 |The number of type | ^all_ads_age_indicators |[]object | |Age indicators for advertisement | ^^type |string |USER_PORTRAIT_AGE_LESS_THAN_15 |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. | ^^value |string |123 |The value for the corresponding age indicator. | ^region_indicators |[]object | |Country-level user portrait indicators for the live room. | ^^value |string |123 |The share rate of region, times 10,000 | ^^type |string |ID |The country of indicators | ^paid_ads_age_indicators |[]object | |Paid advertisement age indicators for advertisement | ^^type |string |USER_PORTRAIT_AGE_LESS_THAN_15 |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. | ^^value |string |123 |The number of type | ^paid_ads_gender_indicators |[]object | |Paid advertisement gender indicators for advertisement | ^^type |string |USER_PORTRAIT_GENDER_UNKNOWN |The stats_type describes the type of value below. USER_PORTRAIT_GENDER_UNKNOWN: The user portrait of the unknown gender USER_PORTRAIT_GENDER_M: The user portrait of the man USER_PORTRAIT_GENDER_F: The user portrait of the female | ^^value |string |123 |The number of type | ^paid_fan_indicators |[]object | |Paid fans indicators | ^^type |string |USER_PORTRAIT_FOLLOWER |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 | ^^value |string |123 |The number of type |

§9 Response Sample

{"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"}

§10 Error Code

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code

Code	Message
66009302	Invalid param. Please check room id.
66009315	No permission for the action.