TikTok-Creator-API

获取创作者直播概览/Get Creator Live Overview

Changed on

[中文]

用途:

  • 获取 TikTok Shop 创作者账号在指定时间范围内的直播表现数据概览。
  • 默认统计从 start_date 当月起 1 个自然月(如传入 2025-04-01,则统计整个 4 月的数据)。

返回内容说明:

  • segments(分段数据列表):
    • time_selector: 时间范围设置(周期、起止时间戳、时区、语言)
    • filter.creator_id: 创作者 ID
    • timed_stats: 每个时间段(通常按日或月分段)的直播表现数据,包含:
      • live_revenue.amount: 直播带货收入
      • live_show_gpm.amount: 直播场均带货收入
      • new_follower_cnt: 新增粉丝数量
      • sku_order_paid_cnt: 已付款 SKU 数量
      • item_sold_cnt: 成交商品件数
      • product_view: 商品曝光次数(浏览量)
      • product_click: 商品点击次数
      • live_pay_order_ucnt: 直播支付订单人数
      • live_ctr: 直播点击率(Click-Through Rate)
      • live_co: 直播转化率(Conversion Rate)
      • live_like_cnt: 直播点赞次数
      • live_comment_cnt: 直播评论次数
      • live_show_cnt: 直播场次
      • live_watch_cnt: 直播观看人数

备注:

  • 此接口仅适用于 TikTok Shop 创作者账号。
  • 直播期间数据按自然日拆分。

参数:

  • cookie: 用户 Cookie 字符串(用于身份认证)
  • start_date: 查询开始时间(格式 MM-DD-YYYY),如 04-01-2025
  • proxy: 可选 HTTP 代理地址,如不使用可省略
    • 示例格式: http://username:password@host:port

返回:

  • 创作者账号直播数据概览

[English]

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"
}
post/api/v1/tiktok/creator/get_live_analytics_summary

Request

  • Base URL
    https://api.tikhub.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

cookiestring

用户 Cookie 字符串/User Cookie String

proxystring nullable

可选 HTTP 代理地址/Optional HTTP Proxy Address

start_datestring

查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025'

Response

Successful Response

codeinteger

HTTP status code | HTTP状态码

request_idstring nullable

Unique request identifier | 唯一请求标识符

messagestring

Response message (EN-US) | 响应消息 (English)

message_zhstring

Response message (ZH-CN) | 响应消息 (中文)

supportstring

Support message | 支持消息

timestring

The time the response was generated | 生成响应的时间

time_stampinteger

The timestamp the response was generated | 生成响应的时间戳

time_zonestring

The timezone of the response time | 响应时间的时区

docsstring nullable

Link to the API Swagger documentation for this endpoint | 此端点的 API Swagger 文档链接

cache_messagestring nullable

Cache message (EN-US) | 缓存消息 (English)

cache_message_zhstring nullable

Cache message (ZH-CN) | 缓存消息 (中文)

cache_urlstring nullable

The URL to access the cached result | 访问缓存结果的 URL

routerstring

The endpoint that generated this response | 生成此响应的端点

paramsunknown
dataunknown

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response's property default value changed from This request will be cached. You can access the cached result directly using the URL below valid for 24 hours. Accessing the cache will not incur additional charges. to This response is cached and accessible via the URL below for 24 hours at no extra cost. The cache is for request tracing only — it doesn't affect the API's data freshness and won't be returned through the API again. for the status

    • info

      the response's property default value changed from 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 to 本次响应已缓存,可通过下方 URL 直接查看,有效期 24 小时,访问缓存链接无额外费用。缓存仅用于请求溯源,不影响接口数据的时效性,也不会再次通过接口返回。 for the status