--- title: "获取创作者直播概览/Get Creator Live Overview" method: POST path: "/api/v1/tiktok/creator/get_live_analytics_summary" tags: ["TikTok-Creator-API"] --- # 获取创作者直播概览/Get Creator Live Overview `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) - URL: `https://api.tikhub.io/api/v1/tiktok/creator/get_live_analytics_summary` - Auth: HTTP bearer # [中文] ### 用途: - 获取 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] ```json { "cookie": "your_cookie", "start_date": "04-01-2025" } ``` ## Request body - GetLiveOverviewRequest - `cookie` string: 用户 Cookie 字符串/User Cookie String - `proxy` string, nullable: 可选 HTTP 代理地址/Optional HTTP Proxy Address - `start_date` string: 查询开始时间，如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' ## Response `200` Successful Response - ResponseModel - `code` integer: HTTP status code | HTTP状态码 - `request_id` string, nullable: Unique request identifier | 唯一请求标识符 - `message` string: Response message (EN-US) | 响应消息 (English) - `message_zh` string: Response message (ZH-CN) | 响应消息 (中文) - `support` string: Support message | 支持消息 - `time` string: The time the response was generated | 生成响应的时间 - `time_stamp` integer: The timestamp the response was generated | 生成响应的时间戳 - `time_zone` string: The timezone of the response time | 响应时间的时区 - `docs` string, nullable: Link to the API Swagger documentation for this endpoint | 此端点的 API Swagger 文档链接 - `cache_message` string, nullable: Cache message (EN-US) | 缓存消息 (English) - `cache_message_zh` string, nullable: Cache message (ZH-CN) | 缓存消息 (中文) - `cache_url` string, nullable: The URL to access the cached result | 访问缓存结果的 URL - `router` string: The endpoint that generated this response | 生成此响应的端点 - `params` unknown - `data` unknown ## Other responses - `422`: Validation Error ## Changes - **2026-10-08** `96a122a5f220`: 2 info - added the optional property `detail/items/ctx` to the response with the `422` status - added the optional property `detail/items/input` to the response with the `422` status - **2026-09-01** `50f9ec6e1cd3`: 2 info - the `cache_message` 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 `200` - the `cache_message_zh` response's property default value changed from `本次请求将被缓存，你可以使用下面的 URL 直接访问缓存结果，有效期为 24 小时，访问缓存不会产生额外费用。` to `本次响应已缓存，可通过下方 URL 直接查看，有效期 24 小时，访问缓存链接无额外费用。缓存仅用于请求溯源，不影响接口数据的时效性，也不会再次通过接口返回。` for the status `200` - **2026-04-14** `ee5b7c9c88f5`: 11 info - added the optional property `cache_message` to the response with the `200` status - added the optional property `cache_message_zh` to the response with the `200` status - added the optional property `cache_url` to the response with the `200` status - added the optional property `docs` to the response with the `200` status - …7 more - **2025-05-16** `14d38e4b883a`: 1 info - endpoint added [Operation history](https://skmtc.dev/tikhub/apis/tikhub-douyin-tiktok-xiaohongshu-lemon8-bilibili-kuaishou-pi/changes/api/v1/tiktok/creator/get_live_analytics_summary/post.md) --- [API](https://skmtc.dev/tikhub/apis/tikhub-douyin-tiktok-xiaohongshu-lemon8-bilibili-kuaishou-pi.md) - [All operations](https://skmtc.dev/tikhub/apis/tikhub-douyin-tiktok-xiaohongshu-lemon8-bilibili-kuaishou-pi/llms.txt) - [OpenAPI document](https://skmtc.dev/tikhub/apis/tikhub-douyin-tiktok-xiaohongshu-lemon8-bilibili-kuaishou-pi/revisions/86a3483c705a?raw)