--- title: "获取创作者账号概览/Get Creator Account Overview" method: POST path: "/api/v1/tiktok/creator/get_account_insights_overview" tags: ["TikTok-Creator-API"] --- # 获取创作者账号概览/Get Creator Account Overview `POST /api/v1/tiktok/creator/get_account_insights_overview` ## 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_account_insights_overview` - Auth: HTTP bearer # [中文] ### 用途: - 获取 TikTok Shop 创作者账号在指定时间范围内的表现概览，包括收益、曝光、点击、成交等多维度数据。 - 默认统计从 `start_date` 当月起 1 个自然月（如传入 2025-04-01，则统计整个 4 月的数据）。 ### 备注: - 此接口仅适用于已开通 TikTok Shop 功能的创作者账号。 - 数据按照时间粒度进行分段统计，可用于数据分析和趋势观察。 ### 参数: - cookie: 用户 Cookie 字符串（用于身份认证） - start_date: 查询开始时间，格式为 'MM-DD-YYYY'，如 '04-01-2025' - proxy: 可选 HTTP 代理地址，如不使用可省略 - 示例格式: `http://username:password@host:port` ### 返回: - `segments`（分段数据列表）: - `time_selector`: 当前统计段的时间设置，包括周期、起止时间戳、时区、语言等 - `timed_stats`: 每天/每段的详细数据，包含以下字段： - `live_revenue.amount`: 直播带货收益 - `video_revenue.amount`: 视频带货收益 - `revenue.amount`: 总收益（直播 + 视频） - `base_revenue.amount`: 基础收益 - `commission_estimated.amount`: 预估佣金 - `alc_base_revenue.amount`: ALC 模式下基础收益 - `overall_item_sold_cnt`: 商品成交数 - `product_show_cnt`: 商品展示次数 - `product_click_cnt`: 商品点击次数 - `alc_pay_sku_order_cnt`: ALC 成交订单数 - `meta.is_bound_shop`: 是否绑定 TikTok 店铺 # [English] ### Purpose: - Retrieve 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). ### Notes: - This API is only applicable to TikTok accounts that have TikTok Shop enabled. - Data is segmented by time granularity (daily/monthly), and can be used for performance analysis or trend monitoring. ### Parameters: - cookie: User cookie string for authentication - start_date: Query start date in 'MM-DD-YYYY' format, e.g. '04-01-2025' - proxy: Optional HTTP proxy address. Leave empty if not needed. - Example format: `http://username:password@host:port` ### Response: - `segments`: List of data segments, each containing: - `time_selector`: Time settings for the segment, including period, timestamp range, timezone, and locale - `timed_stats`: Daily or interval-based statistics, including: - `live_revenue.amount`: Revenue from livestream sales - `video_revenue.amount`: Revenue from video sales - `revenue.amount`: Total revenue (live + video) - `base_revenue.amount`: Base revenue - `commission_estimated.amount`: Estimated commission - `alc_base_revenue.amount`: Base revenue under ALC model - `overall_item_sold_cnt`: Total items sold - `product_show_cnt`: Product exposure count - `product_click_cnt`: Product click count - `alc_pay_sku_order_cnt`: Orders under ALC model - `meta.is_bound_shop`: Whether the TikTok account is bound to a shop ## Request body - GetAccountOverviewRequest - `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_account_insights_overview/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)