Retrieves a paginated list of product-level performance statistics for the specified partner campaign.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The unique id of a campaign
Query Parameters
Section titled “Query Parameters”The number of results to be returned per page. Valid range: 1-50.
An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page.
The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API.
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
The total count of products included in the specified campaign.
A list of objects representing campaign product statistics.
object
The time at which the product data was last updated, in Unix epoch format.
The number of creators credited with at least one product sale.
The total number of creators associated with the campaign.
The number of the creators involved in the campaign.
The total number of samples requested by all creators associated with the campaign.
An object representing the details for the product associated with the campaign.
object
The product identifier.
The product status. This is an enumerated type with values:
- PRODUCT_UNSPECIFIED
- PRODUCT_PENDING
- PRODUCT_APPROVED
- PRODUCT_REJECTED
- PRODUCT_PENDING_CLOSED
- PRODUCT_CLOSED
The product name.
The product’s total available stock quantity across all SKUs.
The total commission rate for the partner plan. It is the sum of creator_commission_percent and partner_commission_percent. The value is in hundredths of a percent. For example, a value of 1000 means 10.00%.
The commission rate for the creator in the partner plan. The value is in hundredths of a percent. For example, a value of 1000 means 10.00%.
The commission rate for the partner in the partner plan. The value is in hundredths of a percent. For example, a value of 1000 means 10.00%.
The commission rate for open collaboration. The value is in hundredths of a percent. For example, a value of 1000 means 10.00%.
The product price.
object
The minimum offered price of the product.
The maximum offered price of the product.
The currency code for the maximum and minimum offered price for the product.
An object representing the product thumbnail.
object
The URI of the product thumbnail image.
A list of URLs for the product thumbnail image.
Key performance indicators for the product.
object
The total number of paid orders. paid_order_num = actual_order_num + {number of paid but returned orders}
The actual number of paid orders.
The total payment amount corresponding to paid_order_num.
GMV, the total payment amount corresponding to actual_order_num.
The partner commission amount corresponding to paid_order_num.
The partner commission amount corresponding to actual_order_num.
The number of creators credited with at least one product sale.
The total number of creators collaborating on the campaign.
The number of creators involved in the partner plan.
The total number of creators that applied for a sample.
The token to use as page_token in the next request. Keep the same campaign_id and page_size on subsequent requests. An empty string indicates that there are no more results.
Example
{ "code": 0, "data": { "total_count": 10, "campaign_product_statistics": [ { "data_update_time": "1736204400000", "creator_sales_num": 1, "collaborated_creators_num": 0, "promoted_creator_num": 0, "sample_requested_creator_num": 0, "campaign_product_detail": { "product_id": "12344", "product_status": "PRODUCT_UNSPECIFIED", "product_name": "summer underwear soft dress summer underwear-001", "product_stock_count": "100", "total_commission_percent": "6000", "creator_commission_percent": "1000", "partner_commission_percent": "5000", "plan_commission_percent": "1400", "product_price": { "min_price": "1.00", "max_price": "3.00", "currency": "USD" }, "product_thumbnail": { "uri": "tos-useast5-i-omjb5zjo8w-tx/178e97ee3b254f9ab237ea7516828266", "url_list": [ "https://p19-oec-ttp.tiktokcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/178e97ee3b254f9ab237ea7516828266~tplv-omjb5zjo8w-resize-jpeg:300:300.jpeg?from=520841845", "https://p16-oec-ttp.tiktokcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/178e97ee3b254f9ab237ea7516828266~tplv-omjb5zjo8w-resize-jpeg:300:300.jpeg?from=520841845" ] }, "indicator_data": { "paid_order_num": "3", "actual_order_num": "0", "estimated_amount": "0", "actual_amount": "0", "estimated_partner_commission": "0", "actual_partner_commission": "0", "creator_sales_num": "0", "collaborated_creators_num": "0", "promoted_creator_num": "0", "sample_requested_creator_num": "0" } } } ], "next_page_token": "0" }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}