> ## Documentation Index
> Fetch the complete documentation index at: https://docs.keyapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 视频排名分析

> 获取 TikTok 视频排行榜，可按播放、互动或销售指标排序，数据来自大规模分析数据集。

<div className="inline-flex items-center gap-2 px-4 py-2 bg-yellow-50 dark:bg-yellow-900/20 border border-yellow-200 dark:border-yellow-800 rounded-lg">
  <span className="text-base">🪙</span>
  <span className="text-sm font-medium text-yellow-900 dark:text-yellow-100"><span className="font-semibold">1 credit</span><span className="text-yellow-700 dark:text-yellow-300 ml-1">每次请求</span></span>
</div>

## Copy for AI

<div className="my-6 rounded-xl border border-gray-200 bg-gray-50 p-5 dark:border-gray-800 dark:bg-gray-900/40">
  <div className="min-w-0">
    <p className="text-base font-semibold text-gray-900 dark:text-gray-100">🤖 让 AI 帮你写调用代码</p>
    <p className="mt-1 text-sm text-gray-700 dark:text-gray-300">点击按钮复制一段结构化提示词，可直接交给 ChatGPT、Claude 或其他 AI 助手生成接口调用代码。</p>
  </div>

  <div className="mt-4">
    <button type="button" className="inline-flex items-center gap-2 rounded-md border border-emerald-300 bg-emerald-50 px-3 py-2 text-sm font-medium text-emerald-800 hover:bg-emerald-100 dark:border-emerald-700 dark:bg-emerald-900/30 dark:text-emerald-100 dark:hover:bg-emerald-900/50" onClick={() => navigator.clipboard.writeText("我想调用 KeyAPI 接口：GET https://api.keyapi.ai/v1/tiktok/video/ranking/analytics\n\n请帮我编写调用代码，并包含必要的错误处理、参数校验和响应处理逻辑。\n\n接口信息：\n\nEndpoint: GET https://api.keyapi.ai/v1/tiktok/video/ranking/analytics\n\nDescription: TikTok 的「视频排名分析」接口用于评估表现、趋势、排名和业务机会，返回统计字段、明细列表和分页信息。适用于达人发现、内容分析、趋势跟踪和增长研究。常用必填参数包括 date、region、video_rank_field、rank_type。\n\nRequired Headers:\n--header 'Authorization: Bearer <YOUR_API_KEY>'\n\nParameters:\n- date (Required): date 参数\n- region (Required): 地区或国家代码，例如 US、GB、DE\n- product_category_id (Optional): product_category_id 标识符\n- created_by_ai (Optional): created_by_ai 参数\n- video_rank_field (Required): video_rank_field 参数\n- rank_type (Required): rank_type 参数\n- page_num (Required): page_num 参数\n- page_size (Required): 每页返回数量\n\nExample Response:\n{\n  \"code\": 0,\n  \"message\": \"success\",\n  \"data\": [\n    {\n      \"avatar\": \"https://echosell-images.tos-ap-southeast-1.volces.com/user-avatar/853/MS4wLjABAAAAJN3v63JkTkZW72ae9hb2Wlb70uzhU8H3AZEKxIVTg38lwBGTx0tSNH7IBcrocdKd.jpg\",\n      \"category\": \"Other\",\n      \"create_time\": \"1769838405\",\n      \"created_by_ai\": \"false\",\n      \"duration\": 15,\n      \"nick_name\": \"ﾌひﾚﾉの\",\n      \"product_category_list\": \"[{ \\\"category_name\\\":\\\"Beauty & Personal Care\\\",\\\"category_id\\\":\\\"601450\\\"}]\",\n      \"reflow_cover\": \"https://echosell-images.tos-ap-southeast-1.volces.com/video-cover/422/7601397977986501919.jpg\",\n      \"region\": \"US\",\n      \"sales_flag\": 1,\n      \"total_comments_cnt\": 0,\n      \"total_digg_cnt\": 0,\n      \"total_favorites_cnt\": 0,\n      \"total_shares_cnt\": 0,\n      \"total_video_sale_cnt\": 5508,\n      \"total_video_sale_gmv_amt\": 44613,\n      \"total_views_cnt\": 0,\n      \"unique_id\": \"iamjuliocr\",\n      \"user_id\": \"6633792625097490438\",\n      \"video_desc\": \"W huzz magnet 🧲 #fyp #ttshopfinds #seasaltspray #level3 #barbertok \",\n      \"video_id\": \"7601397977986501919\",\n      \"video_products\": \"[1729436418527695003]\"\n    }\n  ],\n  \"requestId\": \"b9ff3078-0b12-45b5-8b00-b7017ed18713\"\n}\n\n请根据以上信息给出可直接运行的示例代码。")}>
      ✨ 复制给 AI
    </button>
  </div>
</div>


## OpenAPI

````yaml zh/tiktok.zh.openapi.json GET /v1/tiktok/video/ranking/analytics
openapi: 3.0.1
info:
  title: Tiktok API 中文文档
  description: Tiktok API 的中文参考文档，包含接口用途、参数说明、响应状态和示例结构。
  version: 1.0.0
servers:
  - url: https://api.keyapi.ai
    description: Production
security: []
tags:
  - name: TikTok Influencer
  - name: TikTok Shop Creator
  - name: TikTok Shop
  - name: TikTok Content
  - name: TikTok Intelligence
paths:
  /v1/tiktok/video/ranking/analytics:
    get:
      tags:
        - TikTok 内容
      summary: 视频排名分析
      description: 获取 TikTok 视频排行榜，可按播放、互动或销售指标排序，数据来自大规模分析数据集。
      operationId: get_api_v3_echotik_video_ranklist
      parameters:
        - name: date
          in: query
          description: 榜单日期，格式为 yyyy-MM-dd。
          required: true
          schema:
            type: string
        - name: region
          in: query
          description: 地区代码，例如 US。
          required: true
          schema:
            type: string
        - name: product_category_id
          in: query
          description: 商品一级类目 ID 筛选，用于直播带货视频榜单的商品类目过滤。
          required: false
          schema:
            type: string
        - name: created_by_ai
          in: query
          description: 是否为 AI 生成视频，取值 true 或 false。
          required: false
          schema:
            type: string
        - name: video_rank_field
          in: query
          description: 榜单排序字段，1=total_views_cnt，2=total_video_sale_cnt。
          required: true
          schema:
            type: integer
        - name: rank_type
          in: query
          description: 榜单周期，1=日榜，2=周榜，3=月榜。
          required: true
          schema:
            type: integer
        - name: page_num
          in: query
          description: 页码，从 1 开始，最大支持 100000。
          required: true
          schema:
            type: integer
        - name: page_size
          in: query
          description: 每页返回数量，最大值为 10。
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: 请求成功
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        avatar:
                          type: string
                          title: >-
                            The link to the influencer's profile picture/cover
                            is provided. Please use the download interface to
                            access it.
                        category:
                          type: string
                          title: Creator categories
                        create_time:
                          type: string
                        duration:
                          type: integer
                        nick_name:
                          type: string
                        product_category_list:
                          type: string
                          title: Product category information
                        reflow_cover:
                          type: string
                          title: >-
                            Video cover image URL; please use the download link
                            to access it.
                        region:
                          type: string
                        sales_flag:
                          type: integer
                          title: >-
                            Main sales methods: 0 (no sales), 1 (video sales), 2
                            (live streaming sales)
                        total_comments_cnt:
                          type: integer
                        total_digg_cnt:
                          type: integer
                        total_favorites_cnt:
                          type: integer
                        total_shares_cnt:
                          type: integer
                        total_video_sale_cnt:
                          type: integer
                          title: Video sales (estimated)
                        total_video_sale_gmv_amt:
                          type: integer
                          title: Video sales GMV (estimated)
                        total_views_cnt:
                          type: integer
                        unique_id:
                          type: string
                          title: tiktok ID
                        user_id:
                          type: string
                        video_desc:
                          type: string
                        video_id:
                          type: string
                        video_products:
                          type: string
                          title: Video sales product information
                        created_by_ai:
                          type: string
                  requestId:
                    type: string
                required:
                  - code
                  - message
                  - data
                  - requestId
                example:
                  code: 0
                  message: success
                  data:
                    - avatar: >-
                        https://echosell-images.tos-ap-southeast-1.volces.com/user-avatar/853/MS4wLjABAAAAJN3v63JkTkZW72ae9hb2Wlb70uzhU8H3AZEKxIVTg38lwBGTx0tSNH7IBcrocdKd.jpg
                      category: Other
                      create_time: '1769838405'
                      created_by_ai: 'false'
                      duration: 15
                      nick_name: ﾌひﾚﾉの
                      product_category_list: >-
                        [{ "category_name":"Beauty & Personal
                        Care","category_id":"601450"}]
                      reflow_cover: >-
                        https://echosell-images.tos-ap-southeast-1.volces.com/video-cover/422/7601397977986501919.jpg
                      region: US
                      sales_flag: 1
                      total_comments_cnt: 0
                      total_digg_cnt: 0
                      total_favorites_cnt: 0
                      total_shares_cnt: 0
                      total_video_sale_cnt: 5508
                      total_video_sale_gmv_amt: 44613
                      total_views_cnt: 0
                      unique_id: iamjuliocr
                      user_id: '6633792625097490438'
                      video_desc: >-
                        W huzz magnet 🧲 #fyp #ttshopfinds #seasaltspray #level3
                        #barbertok 
                      video_id: '7601397977986501919'
                      video_products: '[1729436418527695003]'
                  requestId: b9ff3078-0b12-45b5-8b00-b7017ed18713
        '400':
          description: 请求参数错误，请检查必填字段和参数格式
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 400
                  data: null
                  message: 'Missing required parameter: handle'
        '401':
          description: 鉴权失败，请检查 Authorization Header 中的 Bearer Token 或 API Key 是否有效
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 401
                  data: null
                  message: apiKey is null
        '402':
          description: 账户余额或额度不足
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 402
                  data: null
                  message: apiKey quota is not enough
        '429':
          description: 请求过于频繁，已触发限流
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 429
                  data: null
                  message: qps limit exceeded
        '500':
          description: 服务器内部错误，请稍后重试
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 500
                  data: null
                  message: Internal server error
      deprecated: false
      security:
        - JWT Bearer: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl --request GET \
              --url 'https://api.keyapi.ai/v1/tiktok/video/ranking/analytics' \
              --header 'Authorization: Bearer <YOUR_API_KEY>'
        - lang: python
          label: Python
          source: |-
            import requests

            response = requests.get(
                'https://api.keyapi.ai/v1/tiktok/video/ranking/analytics',
                params={},
                headers={'Authorization': 'Bearer <YOUR_API_KEY>'}
            )
            print(response.json())
        - lang: javascript
          label: JavaScript
          source: >-
            const response = await
            fetch('https://api.keyapi.ai/v1/tiktok/video/ranking/analytics',
              {
                method: 'GET',
                headers: { 'Authorization': 'Bearer <YOUR_API_KEY>' }
              }
            );

            const data = await response.json();

            console.log(data);
components:
  securitySchemes:
    JWT Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |-
        接口鉴权凭证。请在请求 Header 中传入 `Authorization: Bearer <YOUR_API_KEY>`。
        可在 [Dashboard](https://keyapi.ai/app/dashboard) 获取你的 API Key。

````