> ## 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 Videos (Analytics)

> Retrieve the list of TikTok videos associated with a product, including view counts, engagement metrics, and conversion 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/videos/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/videos/analytics

Description: Retrieve the list of TikTok videos associated with a product, including view counts, engagement metrics, and conversion data.

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

Parameters:
- product_id (Required): Product unique ID
- product_video_sort_field (Optional): List sort field enumeration.1=total_views_cnt 2=total_digg_cnt 3=total_shares_cnt 4=total_video_sale_cnt 5=total_video_sale_gmv_amt 6=create_time
- sort_type (Optional): Sort order 0=asc 1=desc
- 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": [
{
  "create_time": "1628504241",
  "data_size": "3307751",
  "duration": 38,
  "hash_tag": "#TTshopsHome #lipstik #shade #beauty #wanita #makeup #YOU #FYP #VIRAL #ikatancinta",
  "height": "1024",
  "play_addr": "https://v9-id.tiktokcdn.com/20d1a5abf54218b96da3b349f39b5f2b/64a86f83/video/tos/useast2a/tos-useast2a-pve-0037-aiso/3845f2c4baa84c56acac7e45a3689042/?a=1233&ch=0&cr=13&dr=0&lr=all&cd=0%7C0%7C0%7C&cv=1&br=3334&bt=1667&cs=0&ds=6&ft=iusdqy54Zfc0PD1XC43Xg9wiaE~xvEeC~&mime_type=video_mp4&qs=0&rc=ZmQ8PDo2NTxpZWUzOTgzNEBpM3BlNzk6ZjhpNzMzZjgzM0BgLmMwYC8vXjIxLzAvYTE2YSNyL2tzcjRncTVgLS1kL2Nzcw%3D%3D&l=202307071402364D21C04E909C881CD895&btag=e00080000&cc=1c",
  "product_id": "1729382310407603945",
  "ratio": "540p",
  "reflow_cover": "https://d304ly0se1sg9m.cloudfront.net/video-cover/594/6994372454948900122.jpeg",
  "region": "ID",
  "total_comments_cnt": 2,
  "total_digg_cnt": 20,
  "total_favorites_cnt": 1,
  "total_shares_cnt": 0,
  "total_video_sale_cnt": 0,
  "total_video_sale_gmv_amt": 0,
  "total_views_cnt": 2560,
  "user_id": "6788316924469380097",
  "video_desc": "Harga masih Promo Gaesss... Yakin gak mau ngoleksi? ☺ #TTshopsHome #lipstik #shade #beauty #wanita #makeup #YOU #FYP #VIRAL #ikatancinta",
  "video_id": "6994372454948900122",
  "width": "576"
}
],
"requestId": "bda9f054-17c9-4a1d-ab54-058626e545fa"
}`)}
    >
      <span>✨</span>
      <span>Copy for AI</span>
    </button>
  </div>
</div>


## OpenAPI

````yaml en/tiktok.openapi.json GET /v1/tiktok/product/videos/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/videos/analytics:
    get:
      tags:
        - TikTok Shop
      summary: Product Videos (Analytics)
      description: >-
        Retrieve the list of TikTok videos associated with a product, including
        view counts, engagement metrics, and conversion data.
      operationId: get_api_v3_echotik_product_video_list
      parameters:
        - name: product_id
          in: query
          required: true
          schema:
            type: string
          description: Product unique ID
        - name: product_video_sort_field
          in: query
          description: >-
            List sort field enumeration.1=total_views_cnt 2=total_digg_cnt
            3=total_shares_cnt 4=total_video_sale_cnt 5=total_video_sale_gmv_amt
            6=create_time
          required: false
          schema:
            type: integer
        - name: sort_type
          in: query
          description: Sort order 0=asc 1=desc
          required: false
          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:
                        create_time:
                          type: string
                          title: Video release time
                        data_size:
                          type: string
                        duration:
                          type: integer
                        hash_tag:
                          type: string
                        height:
                          type: string
                        play_addr:
                          type: string
                          title: >-
                            If the video playback address has expired, please
                            use the real-time video interface to obtain the
                            video playback address.
                        product_id:
                          type: string
                        ratio:
                          type: string
                        reflow_cover:
                          type: string
                          title: Video cover URL
                        region:
                          type: string
                        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: Total video sales (estimated)
                        total_video_sale_gmv_amt:
                          type: integer
                          title: Video total sales GMV (estimated)
                        total_views_cnt:
                          type: integer
                        user_id:
                          type: string
                        video_desc:
                          type: string
                        video_id:
                          type: string
                        width:
                          type: string
                  requestId:
                    type: string
                required:
                  - code
                  - message
                  - data
                  - requestId
                example:
                  code: 0
                  message: success
                  data:
                    - create_time: '1628504241'
                      data_size: '3307751'
                      duration: 38
                      hash_tag: >-
                        #TTshopsHome #lipstik #shade #beauty #wanita #makeup
                        #YOU #FYP #VIRAL #ikatancinta
                      height: '1024'
                      play_addr: >-
                        https://v9-id.tiktokcdn.com/20d1a5abf54218b96da3b349f39b5f2b/64a86f83/video/tos/useast2a/tos-useast2a-pve-0037-aiso/3845f2c4baa84c56acac7e45a3689042/?a=1233&ch=0&cr=13&dr=0&lr=all&cd=0%7C0%7C0%7C&cv=1&br=3334&bt=1667&cs=0&ds=6&ft=iusdqy54Zfc0PD1XC43Xg9wiaE~xvEeC~&mime_type=video_mp4&qs=0&rc=ZmQ8PDo2NTxpZWUzOTgzNEBpM3BlNzk6ZjhpNzMzZjgzM0BgLmMwYC8vXjIxLzAvYTE2YSNyL2tzcjRncTVgLS1kL2Nzcw%3D%3D&l=202307071402364D21C04E909C881CD895&btag=e00080000&cc=1c
                      product_id: '1729382310407603945'
                      ratio: 540p
                      reflow_cover: >-
                        https://d304ly0se1sg9m.cloudfront.net/video-cover/594/6994372454948900122.jpeg
                      region: ID
                      total_comments_cnt: 2
                      total_digg_cnt: 20
                      total_favorites_cnt: 1
                      total_shares_cnt: 0
                      total_video_sale_cnt: 0
                      total_video_sale_gmv_amt: 0
                      total_views_cnt: 2560
                      user_id: '6788316924469380097'
                      video_desc: >-
                        Harga masih Promo Gaesss... Yakin gak mau ngoleksi? ☺
                        #TTshopsHome #lipstik #shade #beauty #wanita #makeup
                        #YOU #FYP #VIRAL #ikatancinta
                      video_id: '6994372454948900122'
                      width: '576'
                  requestId: bda9f054-17c9-4a1d-ab54-058626e545fa
        '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/videos/analytics' \
              --header 'Authorization: Bearer <YOUR_API_KEY>'
        - lang: python
          label: Python
          source: |-
            import requests

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

````