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

# Top Products Insights

> Retrieve insights on top-performing TikTok Shop products within a category, including sales rankings and growth metrics.

<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">2 credits</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/insights/products.

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/insights/products

Description: Retrieve insights on top-performing TikTok Shop products within a category, including sales rankings and growth metrics.

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

Parameters:
- search_keyword (Optional): Search keywords, value-taking rules: FALSE (string type) = do not perform the search; non-empty string = perform the search according to the keyword. Example: FALSE
- page (Optional): Pagination page number, used to specify the target page number of the query results. Example: 1
- limit (Optional): The number of data items per page in pagination, which is used to specify the maximum number of results returned by a single query. The value range is 1 to 20. If it exceeds the maximum value, it will be automatically handled as 20.. Example: 20
- time_scope (Optional): The number of data items per page in pagination, which is used to specify the maximum number of results returned by a single query. The value range is 1 to 20. If it exceeds the maximum value, it will be automatically handled as 20.. Example: 1
- region (Optional): Country/region code, example: US. Example: all_regions
- ecom_category_id (Optional): Filter conditions for the third-level category of products, used to limit the range of product categories for querying data. (Third-level category)

Example Response:
{
"code": 0,
"message": "success",
"data": {
"list": [
  {
    "comment": 1029,
    "cost": 48200,
    "cover_url": null,
    "cpa": 4.92,
    "ctr": 1.83,
    "cvr": 5.71,
    "ecom_type": "l3",
    "first_ecom_category": {
      "id": "601450",
      "label": "category_601450",
      "value": "Beauty & Personal Care"
    },
    "impression": 20000000,
    "like": 48452,
    "play_six_rate": 8.77,
    "post": 11500,
    "post_change": 0.27,
    "second_ecom_category": {
      "id": "848648",
      "label": "category_848648",
      "parent_id": "601450",
      "value": "Makeup & Perfume"
    },
    "share": 873,
    "third_ecom_category": {
      "id": "601583",
      "label": "category_601583",
      "parent_id": "848648",
      "value": "Perfume"
    },
    "url_title": "Perfume"
  }
],
"pagination": {
  "page": 1,
  "size": 1,
  "total": 500,
  "has_more": true
}
},
"requestId": "d8a309f6-e55c-4569-b17e-a148368362a4"
}`)}
    >
      <span>✨</span>
      <span>Copy for AI</span>
    </button>
  </div>
</div>


## OpenAPI

````yaml en/tiktok.openapi.json GET /v1/tiktok/insights/products
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/insights/products:
    get:
      tags:
        - TikTok Intelligence
      summary: Top Products Insights
      description: >-
        Retrieve insights on top-performing TikTok Shop products within a
        category, including sales rankings and growth metrics.
      operationId: get_api_v3_realtime_insights_top_product_category_list
      parameters:
        - name: search_keyword
          in: query
          description: >-
            Search keywords, value-taking rules: FALSE (string type) = do not
            perform the search; non-empty string = perform the search according
            to the keyword
          required: false
          schema:
            type: string
            example: 'FALSE'
            default: 'FALSE'
          example: 'FALSE'
        - name: page
          in: query
          description: >-
            Pagination page number, used to specify the target page number of
            the query results
          required: false
          schema:
            type: string
            example: '1'
            default: '1'
          example: '1'
        - name: limit
          in: query
          description: >-
            The number of data items per page in pagination, which is used to
            specify the maximum number of results returned by a single query.
            The value range is 1 to 20. If it exceeds the maximum value, it will
            be automatically handled as 20.
          required: false
          schema:
            type: string
            example: '20'
            default: '20'
          example: '20'
        - name: time_scope
          in: query
          description: >-
            The number of data items per page in pagination, which is used to
            specify the maximum number of results returned by a single query.
            The value range is 1 to 20. If it exceeds the maximum value, it will
            be automatically handled as 20.
          required: false
          schema:
            type: string
            example: '1'
            default: '1'
          example: '1'
        - name: region
          in: query
          description: 'Country/region code, example: US'
          required: false
          schema:
            type: string
            example: all_regions
            default: all_regions
          example: all_regions
        - name: ecom_category_id
          in: query
          description: >-
            Filter conditions for the third-level category of products, used to
            limit the range of product categories for querying data.
            (Third-level category)
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties: {}
                example:
                  code: 0
                  message: success
                  data:
                    list:
                      - comment: 1029
                        cost: 48200
                        cover_url: null
                        cpa: 4.92
                        ctr: 1.83
                        cvr: 5.71
                        ecom_type: l3
                        first_ecom_category:
                          id: '601450'
                          label: category_601450
                          value: Beauty & Personal Care
                        impression: 20000000
                        like: 48452
                        play_six_rate: 8.77
                        post: 11500
                        post_change: 0.27
                        second_ecom_category:
                          id: '848648'
                          label: category_848648
                          parent_id: '601450'
                          value: Makeup & Perfume
                        share: 873
                        third_ecom_category:
                          id: '601583'
                          label: category_601583
                          parent_id: '848648'
                          value: Perfume
                        url_title: Perfume
                    pagination:
                      page: 1
                      size: 1
                      total: 500
                      has_more: true
                  requestId: d8a309f6-e55c-4569-b17e-a148368362a4
        '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/insights/products?search_keyword=FALSE&page=1&limit=20&time_scope=1&region=all_regions' \
              --header 'Authorization: Bearer <YOUR_API_KEY>'
        - lang: python
          label: Python
          source: |-
            import requests

            response = requests.get(
                'https://api.keyapi.ai/v1/tiktok/insights/products',
                params={"search_keyword": "FALSE", "page": "1", "limit": "20", "time_scope": "1", "region": "all_regions"},
                headers={'Authorization': 'Bearer <YOUR_API_KEY>'}
            )
            print(response.json())
        - lang: javascript
          label: JavaScript
          source: >-
            const params = new URLSearchParams({"search_keyword": "FALSE",
            "page": "1", "limit": "20", "time_scope": "1", "region":
            "all_regions"});


            const response = await
            fetch(`https://api.keyapi.ai/v1/tiktok/insights/products?${params}`,
            {
              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).

````