# 获取创作者视频列表分析/Get Creator Video List Analytics

## OpenAPI Specification

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

        ### 用途:

        - 获取 TikTok Shop 创作者账号在指定时间范围内发布的视频列表及其详细数据表现。

        - 支持分页查询，每页返回指定时间段内的视频及其播放、成交等详细数据。


        ### 返回内容说明:

        - `segments`（分段数据列表）:
          - `time_selector`: 查询时间范围（起止时间戳、时区、语言等）
          - `filter.creator_id`: 创作者账号 ID
          - `list_control`:
            - `rules`: 列表排序规则（通常按发布时间降序）
            - `next_pagination`: 翻页信息（是否有更多页，当前页，总页数，总记录数）
          - `timed_lists`: 每个时间段内的视频数据，包括：
            - `video_meta`:
              - `item_id`: 视频 Item ID
              - `name`: 视频标题
              - `publish_time`: 视频发布时间（Unix 时间戳）
              - `duration`: 视频时长（秒）
              - `video_play_info`: 视频播放资源信息（封面图、播放链接等）
            - `new_follower_cnt`: 视频期间新增粉丝数
            - `vv_cnt`: 视频播放量
            - `ctr`: 商品点击率（Click Through Rate）
            - `gmv.amount`: 视频带货产生的总 GMV 金额
            - `item_sold_cnt`: 视频带动的商品售出数量
            - `direct_gmv.amount`: 直接带货 GMV
            - `completion_rate`: 视频观看完成率

        ### 备注:

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

        - 数据按自然日或周分组，且每条视频数据对应一段时间内的统计值。


        ### 参数:

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

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

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

        - rules: 列表排序规则，默认按发布时间排序，可选值如下：
            - `"VIDEO_LIST_PUBLISH_TIME"`：按发布时间排序
            - `"VIDEO_LIST_GMV"`：按商品交易总额排序
            - `"VIDEO_LIST_DIRECT_GMV"`：按直接商品交易总额排序
            - `"VIDEO_LIST_VV_CNT"`：按观看人次数排序
            - `"VIDEO_LIST_ITEM_SOLD_CNT"`：按成交件数排序
            - `"VIDEO_LIST_CTR"`：按商品点击率排序
            - `"VIDEO_LIST_COMPLETION_RATE"`：按观看完播率排序
            - `"VIDEO_LIST_LIKE_CNT"`：按点赞数排序
            - `"VIDEO_LIST_NEW_FOLLOWER_CNT"`：按新增粉丝数排序
        - proxy: 可选 HTTP 代理地址，如不使用可省略
            - 示例格式: `http://username:password@host:port`

        ### 返回:

        - 创作者账号视频列表及详细分析数据


        # [English]

        ### Purpose:

        - Retrieve a list of videos published by a TikTok Shop creator account
        within a specified time range, along with detailed performance metrics.

        - Supports pagination to fetch multiple pages of video records within
        the given time range.


        ### Response Fields:

        - `segments` (List of segmented data):
          - `time_selector`: Time range settings (start/end timestamps, timezone, locale)
          - `filter.creator_id`: Creator account ID
          - `list_control`:
            - `rules`: List sorting rules (typically by publish time descending)
            - `next_pagination`: Pagination information (has more pages, current page, total pages, total records)
          - `timed_lists`: List of videos for each time range, including:
            - `video_meta`:
              - `item_id`: Video Item ID
              - `name`: Video title
              - `publish_time`: Video publish time (Unix timestamp)
              - `duration`: Video duration (seconds)
              - `video_play_info`: Video play resources (cover image, playback URL, etc.)
            - `new_follower_cnt`: Number of new followers during the video's period
            - `vv_cnt`: Video views count
            - `ctr`: Click Through Rate for associated products
            - `gmv.amount`: Gross Merchandise Value generated by the video
            - `item_sold_cnt`: Number of items sold due to the video
            - `direct_gmv.amount`: Direct GMV from the video
            - `completion_rate`: Video completion rate

        ### Notes:

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

        - Data is grouped by natural day or week, and each video's stats
        represent the corresponding period.


        ### Parameters:

        - cookie: User Cookie string for authentication

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

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

        - rules: List sorting rules, default is by publish time. Available
        options:
            - `"VIDEO_LIST_PUBLISH_TIME"`: Sort by video publish time
            - `"VIDEO_LIST_GMV"`: Sort by gross merchandise value (GMV)
            - `"VIDEO_LIST_DIRECT_GMV"`: Sort by direct GMV
            - `"VIDEO_LIST_VV_CNT"`: Sort by video view count
            - `"VIDEO_LIST_ITEM_SOLD_CNT"`: Sort by number of items sold
            - `"VIDEO_LIST_CTR"`: Sort by click-through rate
            - `"VIDEO_LIST_COMPLETION_RATE"`: Sort by video completion rate
            - `"VIDEO_LIST_LIKE_CNT"`: Sort by number of likes
            - `"VIDEO_LIST_NEW_FOLLOWER_CNT"`: Sort by number of new followers
        - proxy: Optional HTTP proxy address, can be omitted if not used
            - Example format: `http://username:password@host:port`

        ### Return:

        - Detailed video list and performance analysis for the creator account


        # [示例/Example]

        ```json

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

        ```
      operationId: get_video_list_api_v1_tiktok_creator_get_video_list_analytics_post
      tags:
        - TikTok-Creator-API
        - TikTok-Creator-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetVideoListRequest'
      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: 2h5juAY5IML-k9t9cMZbN
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: 2h5juAY5IML-k9t9cMZbN
            scopes:
              2h5juAY5IML-k9t9cMZbN:
                HTTPBearer: []
      x-apifox-folder: TikTok-Creator-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-289437016-run
components:
  schemas:
    GetVideoListRequest:
      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
        page:
          type: integer
          title: Page
          description: 页码/Page Number
          default: 0
        rules:
          type: string
          title: Rules
          description: 列表排序规则，默认按发布时间排序/ List sorting rule, default is by publish time
          default: VIDEO_LIST_PUBLISH_TIME
      type: object
      title: GetVideoListRequest
      x-apifox-orders:
        - cookie
        - proxy
        - start_date
        - page
        - rules
      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: []

```