# 获取创作者商品列表分析/Get Creator Product List Analytics

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/tiktok/creator/get_product_analytics_list:
    post:
      summary: 获取创作者商品列表分析/Get Creator Product List Analytics
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取 TikTok Shop 创作者账号在指定时间范围内推广的商品列表及其销售数据分析。

        - 支持按商品成交额、商品上架时间排序，可分页查询。


        ### 返回内容说明:

        - `segments`（分段数据列表）:
          - `filter.creator_id`: 创作者账号 ID
          - `list_control`:
            - `rules`: 列表排序规则（如按成交额、商品 ID 排序）
            - `next_pagination`: 翻页信息（是否还有更多页、下一页页码、总页数、总记录数）
          - `timed_lists`: 每个时间段内的商品数据，包括：
            - `product`:
              - `id`: 商品 ID
              - `name`: 商品标题
              - `cover_image.thumb_url_list`: 商品封面图列表
            - `item_sold_cnt`: 销售商品数量
            - `revenue.amount`: 该商品带来的总成交金额（GMV）
            - `commission.amount`: 该商品预估佣金收入

        ### 备注:

        - 此接口仅适用于 TikTok Shop 创作者账号。

        - 数据以自然月或自定义时间范围统计。

        - 默认排序为成交额（GMV）从高到低。


        ### 参数:

        - cookie: 用户 Cookie 字符串（用于身份认证）

        - start_date: 开始日期，格式为 'YYYY-MM-DD'，如 '2025-04-01'

        - end_date: 结束日期，格式为 'YYYY-MM-DD'，如 '2025-05-01'

        - page: 页码，默认为第一页 `0`

        - proxy: 可选 HTTP 代理地址，如不使用可省略
            - 示例格式: `http://username:password@host:port`

        ### 返回:

        - 创作者账号商品列表及商品销售分析数据


        # [English]

        ### Purpose:

        - Retrieve the list of products promoted by a TikTok Shop creator
        account within a specified time range, along with their sales analytics.

        - Supports sorting by revenue or product publish time and allows
        pagination.


        ### Response Fields:

        - `segments` (List of segmented data):
          - `filter.creator_id`: Creator account ID
          - `list_control`:
            - `rules`: Sorting rules (e.g., by revenue, by product ID)
            - `next_pagination`: Pagination info (has more pages, next page number, total pages, total records)
          - `timed_lists`: List of product statistics within each time range, including:
            - `product`:
              - `id`: Product ID
              - `name`: Product title
              - `cover_image.thumb_url_list`: List of product thumbnail URLs
            - `item_sold_cnt`: Number of items sold
            - `revenue.amount`: Total Gross Merchandise Value (GMV) generated by the product
            - `commission.amount`: Estimated commission income from the product

        ### Notes:

        - This API is only available for TikTok Shop creator accounts.

        - Data is aggregated by natural month or the customized date range.

        - Default sorting is by GMV in descending order.


        ### Parameters:

        - cookie: User Cookie string for authentication

        - start_date: Start date, formatted as 'YYYY-MM-DD', e.g., '2025-04-01'

        - end_date: End date, formatted as 'YYYY-MM-DD', e.g., '2025-05-01'

        - page: Page number, default is the first page `0`

        - proxy: Optional HTTP proxy address, can be omitted if not used
            - Example format: `http://username:password@host:port`

        ### Return:

        - Creator product list and corresponding sales analytics data


        # [示例/Example]

        ```json

        {
          "cookie": "your_cookie",
          "start_date": "2025-04-01",
          "end_date": "2025-05-01",
          "page": 0
        }

        ```
      operationId: >-
        get_product_analytics_list_api_v1_tiktok_creator_get_product_analytics_list_post
      tags:
        - TikTok-Creator-API
        - TikTok-Creator-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetProductListRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseModel'
          headers: {}
          x-apifox-name: OK
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          headers: {}
          x-apifox-name: Unprocessable Entity
      security:
        - HTTPBearer: []
          x-apifox:
            schemeGroups:
              - id: u8hZImI3FQs0bZKA2dyZU
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: u8hZImI3FQs0bZKA2dyZU
            scopes:
              u8hZImI3FQs0bZKA2dyZU:
                HTTPBearer: []
      x-apifox-folder: TikTok-Creator-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-289437017-run
components:
  schemas:
    GetProductListRequest:
      properties:
        cookie:
          type: string
          title: Cookie
          description: 用户 Cookie 字符串/User Cookie String
          default: Your_Cookie_String
        proxy:
          anyOf:
            - type: string
            - type: 'null'
          title: Proxy
          description: 可选 HTTP 代理地址/Optional HTTP Proxy Address
          default: ''
        start_date:
          type: string
          title: Start Date
          description: 开始日期，如 '2025-04-01'/ Start Date, e.g. '2025-04-01'
          default: '2025-04-01'
        end_date:
          type: string
          title: End Date
          description: 结束日期，如 '2025-05-01'/ End Date, e.g. '2025-05-01'
          default: '2025-05-01'
        page:
          type: integer
          title: Page
          description: 页码/Page Number
          default: 0
      type: object
      title: GetProductListRequest
      x-apifox-orders:
        - cookie
        - proxy
        - start_date
        - end_date
        - page
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    ResponseModel:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code | HTTP状态码
          default: 200
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Unique request identifier | 唯一请求标识符
        message:
          type: string
          title: Message
          description: Response message (EN-US) | 响应消息 (English)
          default: Request successful. This request will incur a charge.
        message_zh:
          type: string
          title: Message Zh
          description: Response message (ZH-CN) | 响应消息 (中文)
          default: 请求成功，本次请求将被计费。
        support:
          type: string
          title: Support
          description: Support message | 支持消息
          default: 'Discord: https://discord.gg/aMEAS8Xsvz'
        time:
          type: string
          title: Time
          description: The time the response was generated | 生成响应的时间
        time_stamp:
          type: integer
          title: Time Stamp
          description: The timestamp the response was generated | 生成响应的时间戳
        time_zone:
          type: string
          title: Time Zone
          description: The timezone of the response time | 响应时间的时区
          default: America/Los_Angeles
        docs:
          anyOf:
            - type: string
            - type: 'null'
          title: Docs
          description: >-
            Link to the API Swagger documentation for this endpoint | 此端点的 API
            Swagger 文档链接
        cache_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Message
          description: Cache message (EN-US) | 缓存消息 (English)
          default: >-
            This response is cached and accessible via the URL below for 24
            hours at no extra cost. The cache is for request tracing only — it
            doesn't affect the API's data freshness and won't be returned
            through the API again.
        cache_message_zh:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Message Zh
          description: Cache message (ZH-CN) | 缓存消息 (中文)
          default: >-
            本次响应已缓存，可通过下方 URL 直接查看，有效期 24
            小时，访问缓存链接无额外费用。缓存仅用于请求溯源，不影响接口数据的时效性，也不会再次通过接口返回。
        cache_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Url
          description: The URL to access the cached result | 访问缓存结果的 URL
        router:
          type: string
          title: Router
          description: The endpoint that generated this response | 生成此响应的端点
          default: ''
        params:
          type: string
        data:
          anyOf:
            - type: string
            - type: 'null'
          title: Data
          description: The response data | 响应数据
      type: object
      title: ResponseModel
      x-apifox-orders:
        - code
        - request_id
        - message
        - message_zh
        - support
        - time
        - time_stamp
        - time_zone
        - docs
        - cache_message
        - cache_message_zh
        - cache_url
        - router
        - params
        - data
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
      x-apifox-orders:
        - detail
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
      x-apifox-orders:
        - loc
        - msg
        - type
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
  securitySchemes:
    HTTPBearer:
      type: bearer
      description: >
        ----

        #### API Token Introduction:

        ##### Method 1: Use API Token in the Request Header (Recommended)

        - **Header**: `Authorization`

        - **Format**: `Bearer {token}`

        - **Example**: `{"Authorization": "Bearer your_token"}`

        - **Swagger UI**: Click on the `Authorize` button in the upper right
        corner of the page to enter the API token directly without the `Bearer`
        keyword.


        ##### Method 2: Use API Token in the Cookie (Not Recommended, Use Only
        When Method 1 is Unavailable)

        - **Cookie**: `Authorization`

        - **Format**: `Bearer {token}`

        - **Example**: `Authorization=Bearer your_token`


        #### Get API Token:

        1. Register and log in to your account on the TikHub website.

        2. Go to the user center, click on the API token menu, and create an API
        token.

        3. Copy and use the API token in the request header.

        4. Keep your API token confidential and use it only in the request
        header.


        ----


        #### API令牌简介:

        ##### 方法一：在请求头中使用API令牌（推荐）

        - **请求头**: `Authorization`

        - **格式**: `Bearer {token}`

        - **示例**: `{"Authorization": "Bearer your_token"}`

        - **Swagger UI**: 点击页面右上角的`Authorize`按钮，直接输入API令牌，不需要`Bearer`关键字。


        ##### 方法二：在Cookie中使用API令牌（不推荐，仅在无法使用方法一时使用）

        - **Cookie**: `Authorization`

        - **格式**: `Bearer {token}`

        - **示例**: `Authorization=Bearer your_token`


        #### 获取API令牌:

        1. 在TikHub网站注册并登录账户。

        2. 进入用户中心，点击API令牌菜单，创建API令牌。

        3. 复制并在请求头中使用API令牌。

        4. 保密您的API令牌，仅在请求头中使用。
      scheme: bearer
servers:
  - url: https://api.tikhub.io
    description: Production Environment
security: []

```