> ## 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.

# Video Ranking (Analytics)

> Retrieve ranked lists of TikTok videos by views, engagement, or sales metrics, computed from large-scale analytics data.

<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">per request</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">🤖 Why Code When AI Can Do It For You?</p>
    <p className="mt-1 text-sm text-gray-700 dark:text-gray-300">Stop writing code like it's 1970! Let AI do the heavy lifting - click the sparkles to copy a perfectly formatted prompt for ChatGPT, Claude, or your favorite AI assistant.</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(`I want to make an API call to https://api.keyapi.ai/v1/tiktok/video/ranking/analytics.

Please help me write code to make this API call and handle the response appropriately. Include error handling and best practices.

Here are the details:

Endpoint: GET https://api.keyapi.ai/v1/tiktok/video/ranking/analytics

Description: Retrieve ranked lists of TikTok videos by views, engagement, or sales metrics, computed from large-scale analytics data.

Required Headers:
--header 'Authorization: Bearer <YOUR_API_KEY>'

Parameters:
- date (Required): Specific time of the yyyy-MM-dd format ranking list
- region (Required): Region code, region, such as US
- product_category_id (Optional): Filtering by the first-level category ID of products, used for filtering product categories in the live-streaming sales video rankings
- created_by_ai (Optional): true / false, whether it is an AI video
- video_rank_field (Required): Ranking field 1=total_views_cnt 2=total_video_sale_cnt
- rank_type (Required): Rank Type 1=day 2=week 3=month
- page_num (Required): Page numbers, starting from 1, maximum 100000
- page_size (Required): The maximum number of pages is 10.

Example Response:
{
"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"
}`)}
    >
      <span>✨</span>
      <span>Copy for AI</span>
    </button>
  </div>
</div>


## OpenAPI

````yaml en/tiktok.openapi.json GET /v1/tiktok/video/ranking/analytics
openapi: 3.0.1
info:
  title: Tiktok API english documentation
  description: >-
    The english reference documentation of the Tiktok API includes the
    interface's purpose, parameter description, response status, and sample
    structure.
  version: 1.0.0
servers:
  - url: https://api.keyapi.ai
    description: Production
security: []
tags:
  - name: TikTok Influencer
  - name: TikTok Shop
  - name: TikTok Content
  - name: TikTok Intelligence
paths:
  /v1/tiktok/video/ranking/analytics:
    get:
      tags:
        - TikTok Content
      summary: Video Ranking (Analytics)
      description: >-
        Retrieve ranked lists of TikTok videos by views, engagement, or sales
        metrics, computed from large-scale analytics data.
      operationId: get_api_v3_echotik_video_ranklist
      parameters:
        - name: date
          in: query
          description: Specific time of the yyyy-MM-dd format ranking list
          required: true
          schema:
            type: string
        - name: region
          in: query
          description: Region code, region, such as US
          required: true
          schema:
            type: string
        - name: product_category_id
          in: query
          description: >-
            Filtering by the first-level category ID of products, used for
            filtering product categories in the live-streaming sales video
            rankings
          required: false
          schema:
            type: string
        - name: created_by_ai
          in: query
          description: true / false, whether it is an AI video
          required: false
          schema:
            type: string
        - name: video_rank_field
          in: query
          description: Ranking field 1=total_views_cnt 2=total_video_sale_cnt
          required: true
          schema:
            type: integer
        - name: rank_type
          in: query
          description: Rank Type 1=day 2=week 3=month
          required: true
          schema:
            type: integer
        - name: page_num
          in: query
          description: Page numbers, starting from 1, maximum 100000
          required: true
          schema:
            type: integer
        - name: page_size
          in: query
          description: The maximum number of pages is 10.
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Success
          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: Bad Request
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 400
                  data: null
                  message: 'Missing required parameter: handle'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 401
                  data: null
                  message: apiKey is null
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 402
                  data: null
                  message: apiKey quota is not enough
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 429
                  data: null
                  message: qps limit exceeded
        '500':
          description: Internal Server Error
          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: |-
        API key for authentication. Format: `sk_live_xxxxxxxxxxxxx`
        Get your API key from the [Dashboard](http://keyapi.ai/app/dashboard).

````