TikTok modelsapi generation api

tiktok/creator/video-list-analytics

Retrieve a list of videos published by a TikTok Shop creator account within a specified time range, along with detailed performance metrics. Supports pagination to fetch multiple pages of video records within the given t...

Input
Idle

Example output — click Run to generate your own

API README

Get Creator Video List Analytics

Purpose:

  • Retrieve a list of videos published by a TikTok Shop creator account within a specified time range, along with detailed performance metrics.
  • Supports pagination to fetch multiple pages of video records within the given time range.

Response Fields:

  • segments (List of segmented data):
    • time_selector: Time range settings (start/end timestamps, timezone, locale)
    • filter.creator_id: Creator account ID
    • list_control:
      • rules: List sorting rules (typically by publish time descending)
      • next_pagination: Pagination information (has more pages, current page, total pages, total records)
    • timed_lists: List of videos for each time range, including:
      • video_meta:
        • item_id: Video Item ID
        • name: Video title
        • publish_time: Video publish time (Unix timestamp)
        • duration: Video duration (seconds)
        • video_play_info: Video play resources (cover image, playback URL, etc.)
      • new_follower_cnt: Number of new followers during the video's period
      • vv_cnt: Video views count
      • ctr: Click Through Rate for associated products
      • gmv.amount: Gross Merchandise Value generated by the video
      • item_sold_cnt: Number of items sold due to the video
      • direct_gmv.amount: Direct GMV from the video
      • completion_rate: Video completion rate

Notes:

  • This API is only available for TikTok Shop creator accounts.
  • Data is grouped by natural day or week, and each video's stats represent the corresponding period.

Parameters:

  • cookie: User Cookie string for authentication
  • start_date: Query start date, formatted as 'MM-DD-YYYY', e.g., '04-01-2025'
  • page: Page number, default is the first page 0
  • rules: List sorting rules, default is by publish time. Available options:
    • "VIDEO_LIST_PUBLISH_TIME": Sort by video publish time
    • "VIDEO_LIST_GMV": Sort by gross merchandise value (GMV)
    • "VIDEO_LIST_DIRECT_GMV": Sort by direct GMV
    • "VIDEO_LIST_VV_CNT": Sort by video view count
    • "VIDEO_LIST_ITEM_SOLD_CNT": Sort by number of items sold
    • "VIDEO_LIST_CTR": Sort by click-through rate
    • "VIDEO_LIST_COMPLETION_RATE": Sort by video completion rate
    • "VIDEO_LIST_LIKE_CNT": Sort by number of likes
    • "VIDEO_LIST_NEW_FOLLOWER_CNT": Sort by number of new followers
  • proxy: Optional HTTP proxy address, can be omitted if not used
    • Example format: http://username:password@host:port

Return:

  • Detailed video list and performance analysis for the creator account

[Example]

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

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/live-analytics-summaryRetrieve 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).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.