# 获取创作者账号概览/Get Creator Account Overview

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/tiktok/creator/get_account_insights_overview:
    post:
      summary: 获取创作者账号概览/Get Creator Account Overview
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取 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
      operationId: >-
        get_account_insights_overview_api_v1_tiktok_creator_get_account_insights_overview_post
      tags:
        - TikTok-Creator-API
        - TikTok-Creator-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAccountOverviewRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseModel'
          headers: {}
          x-apifox-name: OK
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          headers: {}
          x-apifox-name: Unprocessable Entity
      security:
        - HTTPBearer: []
          x-apifox:
            schemeGroups:
              - id: HgXD_np6vTw814qBRWKIK
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: HgXD_np6vTw814qBRWKIK
            scopes:
              HgXD_np6vTw814qBRWKIK:
                HTTPBearer: []
      x-apifox-folder: TikTok-Creator-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-289437013-run
components:
  schemas:
    GetAccountOverviewRequest:
      properties:
        cookie:
          type: string
          title: Cookie
          description: 用户 Cookie 字符串/User Cookie String
          default: Your_Cookie_String
        proxy:
          anyOf:
            - type: string
            - type: 'null'
          title: Proxy
          description: 可选 HTTP 代理地址/Optional HTTP Proxy Address
          default: ''
        start_date:
          type: string
          title: Start Date
          description: 查询开始时间，如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025'
          default: 04-01-2025
      type: object
      title: GetAccountOverviewRequest
      x-apifox-orders:
        - cookie
        - proxy
        - start_date
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    ResponseModel:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code | HTTP状态码
          default: 200
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Unique request identifier | 唯一请求标识符
        message:
          type: string
          title: Message
          description: Response message (EN-US) | 响应消息 (English)
          default: Request successful. This request will incur a charge.
        message_zh:
          type: string
          title: Message Zh
          description: Response message (ZH-CN) | 响应消息 (中文)
          default: 请求成功，本次请求将被计费。
        support:
          type: string
          title: Support
          description: Support message | 支持消息
          default: 'Discord: https://discord.gg/aMEAS8Xsvz'
        time:
          type: string
          title: Time
          description: The time the response was generated | 生成响应的时间
        time_stamp:
          type: integer
          title: Time Stamp
          description: The timestamp the response was generated | 生成响应的时间戳
        time_zone:
          type: string
          title: Time Zone
          description: The timezone of the response time | 响应时间的时区
          default: America/Los_Angeles
        docs:
          anyOf:
            - type: string
            - type: 'null'
          title: Docs
          description: >-
            Link to the API Swagger documentation for this endpoint | 此端点的 API
            Swagger 文档链接
        cache_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Message
          description: Cache message (EN-US) | 缓存消息 (English)
          default: >-
            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.
        cache_message_zh:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Message Zh
          description: Cache message (ZH-CN) | 缓存消息 (中文)
          default: >-
            本次响应已缓存，可通过下方 URL 直接查看，有效期 24
            小时，访问缓存链接无额外费用。缓存仅用于请求溯源，不影响接口数据的时效性，也不会再次通过接口返回。
        cache_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Url
          description: The URL to access the cached result | 访问缓存结果的 URL
        router:
          type: string
          title: Router
          description: The endpoint that generated this response | 生成此响应的端点
          default: ''
        params:
          type: string
        data:
          anyOf:
            - type: string
            - type: 'null'
          title: Data
          description: The response data | 响应数据
      type: object
      title: ResponseModel
      x-apifox-orders:
        - code
        - request_id
        - message
        - message_zh
        - support
        - time
        - time_stamp
        - time_zone
        - docs
        - cache_message
        - cache_message_zh
        - cache_url
        - router
        - params
        - data
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
      x-apifox-orders:
        - detail
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
      x-apifox-orders:
        - loc
        - msg
        - type
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
  securitySchemes:
    HTTPBearer:
      type: bearer
      description: >
        ----

        #### API Token Introduction:

        ##### Method 1: Use API Token in the Request Header (Recommended)

        - **Header**: `Authorization`

        - **Format**: `Bearer {token}`

        - **Example**: `{"Authorization": "Bearer your_token"}`

        - **Swagger UI**: Click on the `Authorize` button in the upper right
        corner of the page to enter the API token directly without the `Bearer`
        keyword.


        ##### Method 2: Use API Token in the Cookie (Not Recommended, Use Only
        When Method 1 is Unavailable)

        - **Cookie**: `Authorization`

        - **Format**: `Bearer {token}`

        - **Example**: `Authorization=Bearer your_token`


        #### Get API Token:

        1. Register and log in to your account on the TikHub website.

        2. Go to the user center, click on the API token menu, and create an API
        token.

        3. Copy and use the API token in the request header.

        4. Keep your API token confidential and use it only in the request
        header.


        ----


        #### API令牌简介:

        ##### 方法一：在请求头中使用API令牌（推荐）

        - **请求头**: `Authorization`

        - **格式**: `Bearer {token}`

        - **示例**: `{"Authorization": "Bearer your_token"}`

        - **Swagger UI**: 点击页面右上角的`Authorize`按钮，直接输入API令牌，不需要`Bearer`关键字。


        ##### 方法二：在Cookie中使用API令牌（不推荐，仅在无法使用方法一时使用）

        - **Cookie**: `Authorization`

        - **格式**: `Bearer {token}`

        - **示例**: `Authorization=Bearer your_token`


        #### 获取API令牌:

        1. 在TikHub网站注册并登录账户。

        2. 进入用户中心，点击API令牌菜单，创建API令牌。

        3. 复制并在请求头中使用API令牌。

        4. 保密您的API令牌，仅在请求头中使用。
      scheme: bearer
servers:
  - url: https://api.tikhub.io
    description: Production Environment
security: []

```