v2.video.get_user_demographics
GET /api/v2/video/get_user_demographics
Get user demographics data to better understand the types of viewers that watch your Shopee Video.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/video/get_user_demographics
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| user_id | int | 1 | Shopee's unique identifier for a user. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by(depends on different APIs) partner_id, api path, timestamp, access_token, user_id and partner_key via HMAC-SHA256 hashing algorithm. |
No Request Parameters Set.
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| request_id | string | 2af852cd-7420-4714-b7cd-33317f6fe548 | The identifier for an API request for error tracking. |
| response | object | ||
| age | object | The age distribution of your viewers. Note: The type of age is a map. The key is an enumerated value corresponding to an age range: -1: Unknown 1: 18-24 years old 2: 25-34 years old 3: 35-44 years old 4: 45+ years old The value is the number of viewers in each age group. | |
| gender | object | The gender distribution of your viewers. Note: The type of gender is a map. The key is one of: Male Female Predicted Male Predicted Female The value is the number of viewers for each gender type. | |
| location | object | The geographic distribution of your viewers. Note: The type of location is a map. The key is top 10 city, and the value is the number of viewers in each city. | |
| identity | object | The distribution of viewers based on whether they follow your Shopee Video profile. Note: The type of identity is a map. The key is either "follow" or "unfollow", indicating followers and non-followers respectively, and the value is number of page views generated by each group. | |
| activity | object | The distribution of video views across different hours of the day. Note: The type of activity is a map. The key is the hour of the day (ranging from 0 to 23), and the value is the number of video views generated during that specific hour. | |
| content | object | The types of videos that your viewer is most interested in. Note: The type of content is a map. The key is top 10 content category, and the value is the number of video views corresponding to that content category. | |
| shopping | object | The types of products that your viewers is most interested in. Note: The type of shopping is a map. The key is top 10 product category, and the value is the number of video views corresponding to that product category. |