快工助手跨境电商知识与商机助手

Get Marketplace Creator Performance

TikTok Shop 官方资料 · TikTok Shop Partner Center 开发者文档 · 适合开发者

stable本次发布有变化全部展示

来自 TikTok Shop 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
TikTok Shop / profile.tiktok.docs_api
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/tiktok_shopaudience/developercategory/api_doctopic/compliancetopic/developer

资料正文

§1 Path: /affiliate_seller/202608/marketplace_creators/{creator_user_id}

#

§2 Method: [GET]

#

§3 Function Description

Get the Creator Affiliate's Marketplace information and performance metrics in the last 30 days.


#

§4 Common Parameters

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

Properties Location Type Require Sample Properties description
shop_cipherquerystringYGCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response.
Get by API Get Authorization Shop
content-typeheaderstringYapplication/jsonAllowed type: application/json
#

§5 Request Path Parameters

Properties Type Require Sample Properties description
creator_user_idstringYuACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0ygCreator Open ID. More details
#

§6 Request Query Parameters

Properties Type Require Sample Properties description
app_keystringY38abcdEvery single app will have a unique key. Please use the specific key assigned to your app.
signstringY5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8cSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestampintY1623812664Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
data_groups[]stringNBASIC_CREATOR_INFORMATIONCreator's Data Group, get all group by default, which include:
  • BASIC_CREATOR_INFORMATION
  • CONTENT_PERFORMANCE
  • FOLLOWER_INFORMATION
  • COLLABORATION
  • SALES_AND_GMV |
#

§7 Request Sample

Query

https://open-api.tiktokglobalshop.com/affiliate_seller/202608/marketplace_creators/uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&data_groups=BASIC_CREATOR_INFORMATION
#

§8 Response Parameters

Properties Type Sample Properties description
codeint0The success or failure status code returned in API response.
messagestringSuccessThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstring202203070749000101890810281E8C70B7Request log
dataobjectSpecific return information
^creatorobjectData associated with the creator's TikTok profile.
^^usernamestringdioabTikTok user name.
^^nicknamestringDionTikTok nickname.
^^avatarobjectMetadata and data associated with the creator's TikTok profile avatar.
^^^urlstringhttps://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/2bf6a2485ec8bf93483e4a6ed907e6fd~c5_720x720.webp?lk3s=a5d48078\u0026x-expires=1712988000\u0026x-signature=E8US22KfUCwKz0R%2FMFF6%2FMOmogs%3DThe URL for the creator's TikTok profile avatar.
^^selection_regionstringUSThe region associated with the creator.
^^bio_descriptionstringThis is my personal introductionThe biography description associated with the creator.
^^follower_countint2323The creator's follower count.
^^profile_tt_uristringaweme://user/profile/7200669046446064666?sec_uid=MS4wLjABAAAAvkrSOIMxn2YpXW5qBFVHIbfQ11u2L1hamtgg3mbk5GRPpl1TrnKo5zzQe5T77YLw&from_scene=8&enter_from=scanThe URL for the creator's TikTok profile page.
^^category_ids[]string["60001"]A list of category identifiers associated with the products for which the creator has created posts.
^^top_collaborated_brand_ids[]string["8363021"]A list of the top 10 brands with which the creator has previously collaborated.
^^brand_collaboration_countint76The total number of brands with which the creator has previously collaborated.
^^units_soldint234The total number of units sold. Units are indexed to SKU. Note that if the creator has not given permission for precise data sharing, this property will not be present.
^^units_sold_rangeobjectThe range of minimum number of units sold to maximum number of units sold over the lifetime of the creator account. Note that this property is included if the target market is US only. Note that if the creator has not given permission for precise data sharing, these properties will not be present.
^^^minimum_amountint100The lowest number of units sold.
^^^maximum_amountint1000The highest number of units sold.
^^^formatted_rangestring0-10The formatted range of minimum number of units sold to maximum number of units sold over the lifetime of the creator account.
^^gmvobjectGross merchandise value (GMV) metadata and data associated with the creator. Note that if the creator has not given permission for precise data sharing, these properties will not be present.
^^^currencystringUSDThe currency code.
^^^amountstring3434.23The total GMV associated with the creator.
^^video_gmvobjectThe video GMV metadata and data associated with the creator. Note that if the creator has not given permission for precise data sharing, these properties will not be present.
^^^currencystringUSDThe currency code.
^^^amountstring39232.34The total video GMV associated with the creator.
^^live_gmvobjectLivestream GMV metadata and data associated with the creator. Note that if the creator has not given permission for precise data sharing, these properties will not be present.
^^^currencystringUSDThe currency code.
^^^amountstring3432.34Total livestream GMV associated with the creator.
^^gmv_rangeobjectThe range of GMV values associated with this creator. Note that this property is included if the target market is US only. Note that if the creator has not given permission for precise data sharing, these properties will not be present.
^^^currencystringUSDThe currency code.
^^^minimum_amountstring1000.00The lowest GMV value.
^^^maximum_amountstring10000.00The highest GMV value.
^^^formatted_rangestring$0-$100The formatted range of GMV values associated with this creator.
^^ec_live_engagement_ratestring6000E-commerce live stream engagement rate in hundredths of a percent. For example, 6000 is 60%.
^^category_gmv_distribution[]objectGMV distribution by category.
^^^category_idstring66666The top-level category identifier.
^^^valuestring0.3035GMV associated with the category in hundredths of a percent.
^^content_gmv_distribution[]objectGMV associated with creator content by content type.
^^^content_typestringVIDEOThe content type. This an enumerated type with values:
  • VIDEO
  • LIVE
  • SHOWCASE | ^^^value |string |0.3035 |Content GMV distribution value in hundredths of a percent. | ^^product_original_price_range |object | |Original promoted product price metadata and data associated with the creator. | ^^^currency |string |USD |The currency code. | ^^^minimum_amount |string |2.59 |The lowest original promoted product price. | ^^^maximum_amount |string |343.23 |The higest original promoted product price. | ^^gpm |object | |GMV per mille (GPM) metadata and data associated with the creator. Note that if the creator has not given permission for precise data sharing, these properties will not be present. | ^^^currency |string |USD |The currency code. | ^^^amount |string |10.23 |The GPM amount. | ^^live_gpm |object | |Livestream GMV per mille (GPM) metadata and data associated with the creator. Note that if the creator has not given permission for precise data sharing, these properties will not be present. | ^^^currency |string |USD |The currency code. | ^^^amount |string |44.96 |The livestream GPM amount. | ^^video_gpm |object | |Video GMV per mille (GPM) metadata and data associated with the creator. Note that if the creator has not given permission for precise data sharing, these properties will not be present. | ^^^currency |string |USD |The currency code. | ^^^amount |string |28.89 |The video GPM amount. | ^^gpm_range |object | |The range of GPM values associated with the creator. Note that this property is included if the target market is US. Note that if the creator has not given permission for precise data sharing, these properties will not be present. | ^^^currency |string |USD |The currency code. | ^^^minimum_amount |string |100.00 |The lowest GPM value. | ^^^maximum_amount |string |1000.00 |The highest GPM value. | ^^^formatted_range |string |$0-$100 |The formatted range of GPM values associated with the creator. | ^^video_gpm_range |object | |The range of video GPM values associted with the creator. Note that this property is included if the target market is US. Note that if the creator has not given permission for precise data sharing, these properties will not be present. | ^^^currency |string |USD |The currency code. | ^^^minimum_amount |string |100.00 |The lowest video GPM value. | ^^^maximum_amount |string |1000.00 |The highest video GPM value. | ^^^formatted_range |string |$0-$100 |The formatted range of video GPM values associted with the creator. | ^^live_gpm_range |object | |The range of livestream GPM values associted with the creator. Note that this property is included if the target market is US only. Note that if the creator has not given permission for precise data sharing, these properties will not be present. | ^^^currency |string |USD |The currency code. | ^^^minimum_amount |string |100.00 |The lowest livestream GPM value. | ^^^maximum_amount |string |1000.00 |The highest livestream GPM value. | ^^^formatted_range |string |$0-$100 |The formatted range of livestream GPM values associted with the creator. | ^^promoted_product_num |int |311 |The number of promoted products associated with the creator. | ^^ec_live_count |int |12 |The number of e-commerce livestreams associated with the creator. | ^^ec_video_count |int |34 |The number of e-commerce video posts associated with the creator. | ^^avg_ec_video_play_count |int |1234 |The average number of number of e-commerce video plays. | ^^avg_commission_rate |int |6000 |The average commission rate in hundredths of a percent. Note that if the creator has not given permission for precise data sharing, these properties will not be present. | ^^avg_commission_rate_range |object | |The range of average commission rates associated with the creator. Note that if the creator has not given permission for precise data sharing, these properties will not be present. | ^^^minimum_amount |int |6000 |The smallest average commission rate in hundredths of a percent. | ^^^maximum_amount |int |7000 |The largest average commission rate in hundredths of a percent. | ^^avg_gmv_per_buyer |object | |Average GMV per buyer metadata and data associated with the creator. Note that this property is included if the target market is US only. Note that if the creator has not given permission for precise data sharing, these properties will not be present. | ^^^currency |string |USD |The currency code. | ^^^amount |string |45.68 |The average GMV per buyer amount. | ^^avg_gmv_per_buyer_range |object | |The range of average GMV per buyer associated with the creator. Note that this property is included if the target market is US only. Note that if the creator has not given permission for precise data sharing, these properties will not be present. | ^^^currency |string |USD |The currency code. | ^^^minimum_amount |string |100.00 |The smallest average GMV per buyer. | ^^^maximum_amount |string |1000.00 |The largest average GMV per buyer. | ^^^formatted_range |string |$15-$20 |The formatted range of average GMV per buyer associated with the creator. | ^^avg_ec_live_view_count |int |4355 |Average live stream views with promoted products. | ^^avg_ec_live_like_count |int |344 |Average e-commerce live stream likes. | ^^avg_ec_live_comment_count |int |23 |Average e-commerce live stream comments. | ^^avg_ec_live_share_count |int |3434 |Average e-commerce live stream shares. | ^^avg_ec_video_like_count |int |324 |Average e-commerce video likes. | ^^avg_ec_video_comment_count |int |343 |Average e-commerce video comments. | ^^avg_ec_video_share_count |int |22 |Average e-commerce video shares. | ^^follower_location |[]object | |A list of key–value pairs representing the distribution of followers by location. | ^^^key |string |ID |The location, use TWO-LETTER STATE AND TERRITORY ABBREVIATIONS | ^^^value |string |0.3705 |The proportion of followers from this location, expressed as a decimal (e.g., 0.3705 = 37.05%). | ^^follower_age |[]object | |A list of key–value pairs representing the distribution of followers by age range. | ^^^key |string |18-23 |The age range (e.g., "18–23"). | ^^^value |string |0.2500 |The proportion of followers in this age range, expressed as a decimal (e.g., 0.2500 = 25.00%). | ^^follower_gender |[]object | |A list of key–value pairs representing the distribution of followers by gender. | ^^^key |string |Male |The gender (e.g., "Male", "Female"). | ^^^value |string |0.5000 |The proportion of followers of this gender, expressed as a decimal (e.g., 0.5000 = 50.00%). | ^^pps |string |4.5 |Promotion Performance Score (PPS) The score reflects the quality of a creator's shoppable content and product selection over the past 90 days. A high score may indicate a better shopping experience, with fewer potential refunds or negative reviews. | ^^rating |string |3.2 |Rating from sellers who worked with this creator | ^^ec_video_engagement_rate |string |3000 |The number of post engagements (likes, shares, and comments) divided by the total video views averaged across the videos in the last 30 days. For example, 3000 stands for 0.3 or 30% | ^^post_rate |string |100 |The projected rate at which a creator is likely to post a shoppable video or LIVE after receiving a sample. For example, 3000 stands for 0.3 or 30% | ^^creator_profile |object | |Advanced creator profile infomation. If we return an empty object, it means this filter is not currently supported by your account or region. | ^^^is_official_recommend |bool |false |Creaor has official recommend tag or not | ^^^contact_info_available |bool |false |Is creator contact infomation available | ^^^creator_bind_mcn_name |string |name |Creator bind MCN name | ^^^live_engagement_rate_30d |int |50 |Creator engagement rate last 30 days | ^^^video_play_cnt_30d_med |int |10 |Creator average VIDEO play count last 30 days | ^^^live_view_cnt_30d_med |int |10 |Creator average LIVE view count last 30 days | ^^^live_like_cnt_30d |int |10 |Creator LIVE like count last 30 days | ^^^live_comment_cnt_30d_med |int |10 |Creator average LIVE comment count last 30 days | ^^^live_share_cnt_30d_med |int |10 |Creator average LIVE share count last 30 days | ^^^video_publish_cnt_30d_med |int |10 |Creator average VIDEO publish count last 30 days | ^^^has_invited_90d |bool |false |Has invited before 90 days | ^^^is_creator_blocked |bool |false |Is creator blocked by shop | ^^^creator_level |int |2 |Creator level | ^^^creator_fulfillment_reviews |int |10 |Creator fulfillment reviews | ^^^is_eligible_flat_fee |bool |false |Creator is eligible for flat fee invitation | ^^^is_rising_star |bool |false |Creator has rising star tag or not | ^^^creator_fulfillment_score_90d |string |4.1 |Creator fulfillment score during last 90 days | ^^^sample_score |int |75 |Creator credit total score. e.g. 75 means creator' sample scole is 75/100. | ^^^creator_connect_info |object | |Creator connect infomation | ^^^^is_paired |bool |false |Creator is paired or not | ^^^^is_connect |bool |false |Creator is connect or not | ^^^^is_blocked |bool |false |Creator is blocked or not | ^^^creator_trend_profile |[]object | |Creator trend infomation | ^^^^start_timestamp |int |1784419200 |Trend start timestamp | ^^^^end_timestamp |int |1784419200 |Trend end timestamp | ^^^^gmv |object | |Trend GMV infomation | ^^^^^amount |string |1000 |GMV amount | ^^^^^symbol |string |$ |GMV symbol | ^^^^units_sold |int |1000 |Trend units sold | ^^^^follower |int |1000 |Trend follower | ^^^^engagement_rate |int |558 |Trend engagement rate e.g. 558 means creator's engagement rate is 5.58% |
#

§9 Response Sample

{"code":0,"data":{"creator":{"username":"dioab","nickname":"Dion","avatar":{"url":"https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/2bf6a2485ec8bf93483e4a6ed907e6fd~c5_720x720.webp?lk3s=a5d48078\\u0026x-expires=1712988000\\u0026x-signature=E8US22KfUCwKz0R%2FMFF6%2FMOmogs%3D"},"selection_region":"US","bio_description":"This is my personal introduction","follower_count":2323,"profile_tt_uri":"aweme://user/profile/7200669046446064666?sec_uid=MS4wLjABAAAAvkrSOIMxn2YpXW5qBFVHIbfQ11u2L1hamtgg3mbk5GRPpl1TrnKo5zzQe5T77YLw\u0026from_scene=8\u0026enter_from=scan","category_ids":["60001"],"top_collaborated_brand_ids":["8363021"],"brand_collaboration_count":76,"units_sold":234,"units_sold_range":{"minimum_amount":100,"maximum_amount":1000,"formatted_range":"0-10"},"gmv":{"currency":"USD","amount":"3434.23"},"video_gmv":{"currency":"USD","amount":"39232.34"},"live_gmv":{"currency":"USD","amount":"3432.34"},"gmv_range":{"currency":"USD","minimum_amount":"1000.00","maximum_amount":"10000.00","formatted_range":"$0-$100"},"ec_live_engagement_rate":"6000","category_gmv_distribution":[{"category_id":"66666","value":"0.3035"}],"content_gmv_distribution":[{"content_type":"VIDEO","value":"0.3035"}],"product_original_price_range":{"currency":"USD","minimum_amount":"2.59","maximum_amount":"343.23"},"gpm":{"currency":"USD","amount":"10.23"},"live_gpm":{"currency":"USD","amount":"44.96"},"video_gpm":{"currency":"USD","amount":"28.89"},"gpm_range":{"currency":"USD","minimum_amount":"100.00","maximum_amount":"1000.00","formatted_range":"$0-$100"},"video_gpm_range":{"currency":"USD","minimum_amount":"100.00","maximum_amount":"1000.00","formatted_range":"$0-$100"},"live_gpm_range":{"currency":"USD","minimum_amount":"100.00","maximum_amount":"1000.00","formatted_range":"$0-$100"},"promoted_product_num":311,"ec_live_count":12,"ec_video_count":34,"avg_ec_video_play_count":1234,"avg_commission_rate":6000,"avg_commission_rate_range":{"minimum_amount":6000,"maximum_amount":7000},"avg_gmv_per_buyer":{"currency":"USD","amount":"45.68"},"avg_gmv_per_buyer_range":{"currency":"USD","minimum_amount":"100.00","maximum_amount":"1000.00","formatted_range":"$15-$20"},"avg_ec_live_view_count":4355,"avg_ec_live_like_count":344,"avg_ec_live_comment_count":23,"avg_ec_live_share_count":3434,"avg_ec_video_like_count":324,"avg_ec_video_comment_count":343,"avg_ec_video_share_count":22,"follower_location":[{"key":"ID","value":"0.3705"}],"follower_age":[{"key":"18-23","value":"0.2500"}],"follower_gender":[{"key":"Male","value":"0.5000"}],"pps":"4.5","rating":"3.2","ec_video_engagement_rate":"3000","post_rate":"100","creator_profile":{"is_official_recommend":false,"contact_info_available":false,"creator_bind_mcn_name":"name","live_engagement_rate_30d":50,"video_play_cnt_30d_med":10,"live_view_cnt_30d_med":10,"live_like_cnt_30d":10,"live_comment_cnt_30d_med":10,"live_share_cnt_30d_med":10,"video_publish_cnt_30d_med":10,"has_invited_90d":false,"is_creator_blocked":false,"creator_level":2,"creator_fulfillment_reviews":10,"is_eligible_flat_fee":false,"is_rising_star":false,"creator_fulfillment_score_90d":"4.1","sample_score":75,"creator_connect_info":{"is_paired":false,"is_connect":false,"is_blocked":false},"creator_trend_profile":[{"start_timestamp":1784419200,"end_timestamp":1784419200,"gmv":{"amount":"1000","symbol":"
quot;},"units_sold":1000,"follower":1000,"engagement_rate":558}]}}},"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
16032012only affiliate partner cipher can access this api
16901005this creator does't have e-commerce permission,please check the request params.
16901006creator selection region doesn't match seller's region
16901007The seller could not obtain an official creator profile due to insufficient permissions.
16901008The creator didn't didn't have e-commerce permissions or has been deactivated.
16901009can't access tiktok linkshare creator
36009002Too many requests. You've made too many requests in a short period of time.
45101004The query quota has been reached (10000 request per day). Please try again tomorrow.
36009003Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support.
98001004Parameter {param_name} is invalid. Reason: {reason}. Expected: {expected_value}
#