# 获取视频与商品关联统计数据/Get Video-Product Association Statistics

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/tiktok/creator/get_video_to_product_stats:
    post:
      summary: 获取视频与商品关联统计数据/Get Video-Product Association Statistics
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取指定 TikTok 视频与指定商品关联的推广详细统计数据。

        - 支持分析视频为商品带来的商品浏览量、点击量、销售量、订单量、商品收入、直接收入等多维度指标。

        - 返回数据按时间段（日/周/月）分段统计，便于观察趋势变化。


        ### 备注:

        - 必须同时提供 item_id（视频 ID）和 product_id（商品 ID）。

        - 时间范围基于 start_date 所在自然月。


        ### 参数:

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

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

        - item_id: 视频 ID，例如 "7496499484705246507"

        - product_id: 商品 ID，例如 "1731050202505515549"

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

        ### 返回内容说明:

        - `segments`（数据分段列表）:
          - `time_selector`: 时间筛选参数（period, granularity, start_timestamp, end_timestamp）
          - `filter`: 查询条件（creator_id, item_id, product_id）
          - `timed_stats`: 按时间段分段的统计数据
            - `start_timestamp`: 时间段开始时间戳
            - `end_timestamp`: 时间段结束时间戳
            - `stats`:
              - `item_id`: 视频 ID
              - `product_id`: 商品 ID
              - `product_revenue.amount_formatted`: 商品产生的总收入（格式化字符串，如 "$100.00"）
              - `product_revenue.amount`: 商品产生的总收入（数值）
              - `direct_revenue.amount_formatted`: 直接成交产生的收入（格式化字符串）
              - `product_sales_cnt`: 商品销售数量
              - `product_view_cnt`: 商品浏览量
              - `product_click_cnt`: 商品点击量
              - `order_cnt`: 生成订单数量

        ### 示例请求体:

        ```json

        {
          "cookie": "your_cookie",
          "start_date": "04-01-2025",
          "item_id": "7496499484705246507",
          "product_id": "1731050202505515549"
        }

        ```


        # [English]

        ### Purpose:

        - Retrieve detailed promotional statistics between a specific TikTok
        video and a specific product.

        - Supports analyzing metrics such as product views, clicks, sales, order
        counts, product revenue, and direct revenue.

        - The data is segmented by time intervals (daily/weekly/monthly) to
        observe trends over time.


        ### Notes:

        - Requires both item_id (video ID) and product_id (product ID).

        - The time range is based on the calendar month of the specified
        start_date.


        ### Return Description:

        - `segments`:
          - `time_selector`: Time filtering parameters (period, granularity, start_timestamp, end_timestamp)
          - `filter`: Query conditions (creator_id, item_id, product_id)
          - `timed_stats`: Segmented statistics list
            - `start_timestamp`: Start timestamp
            - `end_timestamp`: End timestamp
            - `stats`:
              - `item_id`: Video ID
              - `product_id`: Product ID
              - `product_revenue.amount_formatted`: Total product revenue (formatted string, e.g., "$100.00")
              - `product_revenue.amount`: Total product revenue (numeric)
              - `direct_revenue.amount_formatted`: Direct sales revenue (formatted string)
              - `product_sales_cnt`: Number of products sold
              - `product_view_cnt`: Number of product views
              - `product_click_cnt`: Number of product clicks
              - `order_cnt`: Number of orders created

        ### Example Request Body:

        ```json

        {
          "cookie": "your_cookie",
          "start_date": "04-01-2025",
          "item_id": "7496499484705246507",
          "product_id": "1731050202505515549"
        }

        ```
      operationId: >-
        get_video_to_product_stats_api_v1_tiktok_creator_get_video_to_product_stats_post
      tags:
        - TikTok-Creator-API
        - TikTok-Creator-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetVideoToProductStatsRequest'
      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: I7sJZJITUfNdGotn0XfCU
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: I7sJZJITUfNdGotn0XfCU
            scopes:
              I7sJZJITUfNdGotn0XfCU:
                HTTPBearer: []
      x-apifox-folder: TikTok-Creator-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-291555430-run
components:
  schemas:
    GetVideoToProductStatsRequest:
      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: 查询开始时间，如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025'
          default: 04-01-2025
        item_id:
          type: string
          title: Item Id
          description: 视频 ID/Video ID
        product_id:
          type: string
          title: Product Id
          description: 商品 ID/Product ID
      type: object
      required:
        - item_id
        - product_id
      title: GetVideoToProductStatsRequest
      x-apifox-orders:
        - cookie
        - proxy
        - start_date
        - item_id
        - product_id
      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: []

```