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

# Product Ranking (Analytics)

> Retrieve ranked lists of TikTok Shop products by sales volume, GMV, or other 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/product/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/product/ranking/analytics

Description: Retrieve ranked lists of TikTok Shop products by sales volume, GMV, or other metrics, computed from large-scale analytics data.

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

Parameters:
- date (Required): List date, yyyy-MM-dd format
- region (Required): Region code, region, e.g. US
- category_id (Optional)
- category_l2_id (Optional)
- category_l3_id (Optional)
- product_rank_field (Required): Ranking field1=total_sale_cnt 2=total_ifl_cnt
- rank_type (Required): The ranking cycle is as follows: 1 = Daily Ranking, 2 = Weekly Ranking, 3 = Monthly Ranking.
- page_num (Required): Page numbers start from 1 and go up to a maximum of 100,000.
- page_size (Required): The maximum number of pages is 10.

Example Response:
{
"code": 0,
"message": "success",
"data": [
{
  "category_id": "700645",
  "category_l2_id": "700646",
  "category_l3_id": "700650",
  "max_price": 26.77,
  "min_price": 21.59,
  "product_commission_rate": 0.15,
  "product_id": "1729413266549936259",
  "product_name": "Neuro Energy Caffeine Gum/Mints for Energy & Focus - Sugar-Free with L theanine, Caffeine, Vitamin B12 & Vitamin B6 - Peppermint Flavor",
  "region": "US",
  "spu_avg_price": 24.18,
  "total_ifl_cnt": 64,
  "total_live_cnt": 0,
  "total_sale_cnt": 4539,
  "total_sale_gmv_amt": 109753.02,
  "total_video_cnt": 95
}
],
"requestId": "af1eb642-cbb6-405a-b05b-84593afd41fc"
}`)}
    >
      <span>✨</span>
      <span>Copy for AI</span>
    </button>
  </div>
</div>


## OpenAPI

````yaml en/tiktok.openapi.json GET /v1/tiktok/product/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/product/ranking/analytics:
    get:
      tags:
        - TikTok Shop
      summary: Product Ranking (Analytics)
      description: >-
        Retrieve ranked lists of TikTok Shop products by sales volume, GMV, or
        other metrics, computed from large-scale analytics data.
      operationId: get_api_v3_echotik_product_ranklist
      parameters:
        - name: date
          in: query
          description: List date, yyyy-MM-dd format
          required: true
          schema:
            type: string
        - name: region
          in: query
          description: Region code, region, e.g. US
          required: true
          schema:
            type: string
        - name: category_id
          in: query
          required: false
          schema:
            type: string
        - name: category_l2_id
          in: query
          required: false
          schema:
            type: string
        - name: category_l3_id
          in: query
          required: false
          schema:
            type: string
        - name: product_rank_field
          in: query
          description: Ranking field1=total_sale_cnt 2=total_ifl_cnt
          required: true
          schema:
            type: integer
        - name: rank_type
          in: query
          description: >-
            The ranking cycle is as follows: 1 = Daily Ranking, 2 = Weekly
            Ranking, 3 = Monthly Ranking.
          required: true
          schema:
            type: integer
        - name: page_num
          in: query
          description: Page numbers start from 1 and go up to a maximum of 100,000.
          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:
                        category_id:
                          type: string
                        category_l2_id:
                          type: string
                        category_l3_id:
                          type: string
                        max_price:
                          type: number
                          title: SKU highest price
                        min_price:
                          type: number
                          title: SKU lowest price
                        product_commission_rate:
                          type: number
                          title: Commission rate
                        product_id:
                          type: string
                        product_name:
                          type: string
                        region:
                          type: string
                        spu_avg_price:
                          type: number
                          title: Average price per SKU
                        total_ifl_cnt:
                          type: integer
                          title: Total number of sales creators
                        total_live_cnt:
                          type: integer
                          title: Total live stream sessions
                        total_sale_cnt:
                          type: integer
                          title: Sales growth during the ranking period
                        total_sale_gmv_amt:
                          type: number
                          title: Sales GMV increase during the ranking period
                        total_video_cnt:
                          type: integer
                          title: Total video count
                  requestId:
                    type: string
                required:
                  - code
                  - message
                  - data
                  - requestId
                example:
                  code: 0
                  message: success
                  data:
                    - category_id: '700645'
                      category_l2_id: '700646'
                      category_l3_id: '700650'
                      max_price: 26.77
                      min_price: 21.59
                      product_commission_rate: 0.15
                      product_id: '1729413266549936259'
                      product_name: >-
                        Neuro Energy Caffeine Gum/Mints for Energy & Focus -
                        Sugar-Free with L theanine, Caffeine, Vitamin B12 &
                        Vitamin B6 - Peppermint Flavor
                      region: US
                      spu_avg_price: 24.18
                      total_ifl_cnt: 64
                      total_live_cnt: 0
                      total_sale_cnt: 4539
                      total_sale_gmv_amt: 109753.02
                      total_video_cnt: 95
                  requestId: af1eb642-cbb6-405a-b05b-84593afd41fc
        '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/product/ranking/analytics' \
              --header 'Authorization: Bearer <YOUR_API_KEY>'
        - lang: python
          label: Python
          source: |-
            import requests

            response = requests.get(
                'https://api.keyapi.ai/v1/tiktok/product/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/product/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).

````