TikTok-Creator-API

获取创作者视频概览/Get Creator Video Overview

Changed on

[中文]

用途:

  • 获取 TikTok Shop 创作者账号在指定时间范围内的视频表现概览。
  • 默认统计从调用当天向前 30 天的数据(或按平台设定的自然月分段)。
  • 适合用于视频表现分析,例如视频数量、播放量、粉丝增长、成交数据等。

返回内容说明:

  • segments(分段数据列表):
    • time_selector: 时间范围设置信息(周期、起止时间戳、时区、语言)
    • filter.creator_id: 创作者账号 ID
    • timed_stats: 每个时间段的视频表现数据,包含:
      • vv_cnt: 视频播放量(Video Views Count)
      • new_follower_cnt: 新增粉丝数量
      • video_cnt: 发布视频数量
      • gmv.amount: 视频带货产生的 GMV 金额
      • items_sold: 售出商品数量

备注:

  • 此接口仅适用于 TikTok Shop 创作者账号。
  • 如果某个时间段无数据,返回的 stats 字段可能为空 {}。

参数:

  • cookie: 用户 Cookie 字符串(用于身份认证)
  • proxy: 可选 HTTP 代理地址,如不使用可省略
    • 示例格式: http://username:password@host:port

返回:

  • 创作者账号视频表现概览

[English]

Purpose:

  • Retrieve 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.

Response Fields:

  • segments (List of segmented data):
    • time_selector: Time period settings (period, start/end timestamps, timezone, locale)
    • filter.creator_id: Creator account ID
    • timed_stats: Video performance statistics for each time segment, including:
      • vv_cnt: Video Views Count
      • new_follower_cnt: Number of new followers
      • video_cnt: Number of videos published
      • gmv.amount: Gross Merchandise Value generated by videos
      • items_sold: Number of items sold

Notes:

  • This API is only available for TikTok Shop creator accounts.
  • If no data is available for a time segment, the stats field might be an empty {}.

Parameters:

  • cookie: User Cookie string for authentication
  • proxy: Optional HTTP proxy address, can be omitted if not used
    • Example format: http://username:password@host:port

Return:

  • Creator account video performance overview

[示例/Example]

{
  "cookie": "your_cookie"
}
post/api/v1/tiktok/creator/get_video_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

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