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

# Shop Livestreams (Analytics)

> Retrieve historical livestream records for a TikTok Shop, including viewer counts, GMV generated, and product sales data from each session.

<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/shop/livestreams/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/shop/livestreams/analytics

Description: Retrieve historical livestream records for a TikTok Shop, including viewer counts, GMV generated, and product sales data from each session.

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

Parameters:
- seller_id (Required): Shop Id
- seller_live_sort_field (Optional): List sorting enumeration.1=total_views_cnt 2=total_sale_cnt 3=total_sale_gmv_amt
- 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": [
{
  "avatar": "https://p16-pu-useast8.tiktokcdn-us.com/tos-useast5-avt-0068-tx/8f39499ea4964ab3e77a8dd69de7ce73~tplv-tiktok-shrink:96:96.webp?s=PUBLISH&se=false&sh=96_96&sc=avatar&l=202403201000487587F9F97CCB1101112B",
  "cover_url": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/8f39499ea4964ab3e77a8dd69de7ce73~c5_720x720.webp?x-expires=1694055600&x-signature=FSK9hz4bmN0vbprAxtkUmDe4avM%3D",
  "create_time": 1693876970,
  "duration": 8030,
  "finish_time": 1693885000,
  "max_views_cnt": 0,
  "nick_name": "🛍ubeufashion🛍",
  "region": "US",
  "room_id": "7275145563308362538",
  "seller_id": "7494818275540568755",
  "title": "TikTok Shop Fashion Review",
  "total_joins_cnt": 2734,
  "total_sale_cnt": 0,
  "total_sale_gmv_amt": 0,
  "total_views_cnt": 3132,
  "user_id": "6798340844577768453"
}
],
"requestId": "dbab4133-4b72-4d7d-9579-7ac5107ab76a"
}`)}
    >
      <span>✨</span>
      <span>Copy for AI</span>
    </button>
  </div>
</div>


## OpenAPI

````yaml en/tiktok.openapi.json GET /v1/tiktok/shop/livestreams/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/shop/livestreams/analytics:
    get:
      tags:
        - TikTok Shop
      summary: Shop Livestreams (Analytics)
      description: >-
        Retrieve historical livestream records for a TikTok Shop, including
        viewer counts, GMV generated, and product sales data from each session.
      operationId: get_api_v3_echotik_seller_live_list
      parameters:
        - name: seller_id
          in: query
          description: Shop Id
          required: true
          schema:
            type: string
        - name: seller_live_sort_field
          in: query
          description: >-
            List sorting enumeration.1=total_views_cnt 2=total_sale_cnt
            3=total_sale_gmv_amt
          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:
                        avatar:
                          type: string
                          title: >-
                            For the profile picture of the influencer, please
                            use the download interface to access it.
                        cover_url:
                          type: string
                          title: >-
                            Live stream cover image URL. Please use the download
                            interface to access.
                        create_time:
                          type: integer
                          title: Live broadcast start time
                        duration:
                          type: integer
                          title: Live stream duration (seconds)
                        finish_time:
                          type: integer
                          title: Live broadcast end time
                        max_views_cnt:
                          type: integer
                          title: Peak number of people
                        nick_name:
                          type: string
                        region:
                          type: string
                        room_id:
                          type: string
                          title: Live Stream ID
                        seller_id:
                          type: string
                        title:
                          type: string
                        total_joins_cnt:
                          type: integer
                          title: Number of viewers
                        total_sale_cnt:
                          type: integer
                          title: Livestream sales (estimated)
                        total_sale_gmv_amt:
                          type: integer
                          title: Live streaming GMV (estimated)
                        total_views_cnt:
                          type: integer
                          title: Total number of views
                        user_id:
                          type: string
                  requestId:
                    type: string
                required:
                  - code
                  - message
                  - data
                  - requestId
                example:
                  code: 0
                  message: success
                  data:
                    - avatar: >-
                        https://p16-pu-useast8.tiktokcdn-us.com/tos-useast5-avt-0068-tx/8f39499ea4964ab3e77a8dd69de7ce73~tplv-tiktok-shrink:96:96.webp?s=PUBLISH&se=false&sh=96_96&sc=avatar&l=202403201000487587F9F97CCB1101112B
                      cover_url: >-
                        https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/8f39499ea4964ab3e77a8dd69de7ce73~c5_720x720.webp?x-expires=1694055600&x-signature=FSK9hz4bmN0vbprAxtkUmDe4avM%3D
                      create_time: 1693876970
                      duration: 8030
                      finish_time: 1693885000
                      max_views_cnt: 0
                      nick_name: 🛍ubeufashion🛍
                      region: US
                      room_id: '7275145563308362538'
                      seller_id: '7494818275540568755'
                      title: TikTok Shop Fashion Review
                      total_joins_cnt: 2734
                      total_sale_cnt: 0
                      total_sale_gmv_amt: 0
                      total_views_cnt: 3132
                      user_id: '6798340844577768453'
                  requestId: dbab4133-4b72-4d7d-9579-7ac5107ab76a
        '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/shop/livestreams/analytics' \
              --header 'Authorization: Bearer <YOUR_API_KEY>'
        - lang: python
          label: Python
          source: |-
            import requests

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

````