SandBaseSandBase
Start building
Use in agentDocsTikTok models

TikTok modelsapi generation api

tiktok/creator/live-analytics-summary

Retrieve a summary of live streaming performance for a TikTok Shop creator account within a specified time range. By default, it covers one full calendar month starting from the provided `start_date` (e.g., input `04-01-...

Input
Idle

Example output — click Run to generate your own

API README

Get Creator Live Overview

Purpose:

  • Retrieve a summary of live streaming performance for a TikTok Shop creator account within a specified time range.
  • By default, it covers one full calendar month starting from the provided start_date (e.g., input 04-01-2025 will fetch data for the entire April 2025).

Response Fields:

  • segments (List of segmented data):
    • time_selector: Time period settings (period, start/end timestamps, timezone, locale)
    • filter.creator_id: Creator ID
    • timed_stats: Live performance statistics per time segment, including:
      • live_revenue.amount: Live streaming revenue
      • live_show_gpm.amount: Average revenue per live show
      • new_follower_cnt: Number of new followers
      • sku_order_paid_cnt: Number of SKUs paid
      • item_sold_cnt: Number of items sold
      • product_view: Number of product views
      • product_click: Number of product clicks
      • live_pay_order_ucnt: Number of unique users who placed live orders
      • live_ctr: Live Click-Through Rate (CTR)
      • live_co: Live Conversion Rate (CO)
      • live_like_cnt: Number of live likes
      • live_comment_cnt: Number of live comments
      • live_show_cnt: Number of live sessions
      • live_watch_cnt: Number of live viewers

Notes:

  • This API is only applicable to TikTok Shop creator accounts.
  • Data is split by natural days during the live sessions.

Parameters:

  • cookie: User Cookie string for authentication
  • start_date: Query start date in the format MM-DD-YYYY, e.g., 04-01-2025
  • proxy: Optional HTTP proxy address, can be omitted if not used
    • Example format: http://username:password@host:port

Return:

  • Creator live streaming performance overview

[Example]

{
  "cookie": "your_cookie",
  "start_date": "04-01-2025"
}

Imported from a validated TikHub OpenAPI document. Pricing must be reviewed before enabling.

Related Models

tiktok/creator/account-health-statusRetrieve the health status of a TikTok Shop creator account, including the health score over the past 90 days and the current number of accumulated violation points. About violation points: Violation points are key metrics used by TikTok to measure the health of a creator account. Higher violation points indicate worse account health, and may lead to restrictions such as reduced exposure, suspension, or account bans. Violation points directly impact the account’s visibility and recommendation on the platform.tiktok/creator/account-insights-overviewRetrieve performance overview of a TikTok Shop creator account within a specified date range, including metrics like revenue, exposure, clicks, and orders. By default, it aggregates data from the month of `start_date` (e.g., if `start_date` is 2025-04-01, it retrieves data for the entire month of April).tiktok/creator/account-violation-listRetrieve the violation history of a TikTok Shop creator account, providing details about past violations and corresponding enforcement actions. The returned violation records include violation type, violation time, violation reasons, enforcement actions, appeal status, and eligibility for appeal. Pagination is supported to retrieve multiple records in chronological order. Suitable for creator account risk management, health monitoring, and compliance auditing.tiktok/creator/creator-account-infoRetrieve basic information of a TikTok Shop creator account, including username, avatar URLs, account ID, register region, partner binding info, and permission list. Useful for verifying account status, displaying user profile data, checking partner binding status, and determining access permissions for business processes.tiktok/creator/product-analytics-listRetrieve the list of products promoted by a TikTok Shop creator account within a specified time range, along with their sales analytics. Supports sorting by revenue or product publish time and allows pagination.tiktok/creator/product-related-videosRetrieve the list of all videos associated with a specified product along with their interaction metrics (such as like count, comment count, share count). Useful for analyzing the promotional effectiveness and differences of the same product across different creators' videos. Supports time-based filtering, defaulting to the calendar month of the specified start_date.tiktok/creator/showcase-product-listRetrieve the list of products currently displayed in a TikTok Shop creator's showcase. Useful for product management, analytics, and monitoring promoted items.tiktok/creator/video-analytics-summaryRetrieve a video performance overview for a TikTok Shop creator account over a specified time range. By default, the API fetches data for the past 30 days (or full calendar month based on the platform settings). Useful for analyzing metrics like video count, views, new followers, and generated GMV.