# 获取创作者账号健康状态/Get Creator Account Health Status

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/tiktok/creator/get_account_health_status:
    post:
      summary: 获取创作者账号健康状态/Get Creator Account Health Status
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取 TikTok Shop 创作者账号的健康状况信息，包括过去 90 天内的健康评分（风险等级）以及当前累计的违规积分数量。

        - 关于违规积分：
            - 违规积分是 TikTok 用于衡量账号健康状况的重要指标。
            - 违规积分越高，账号健康状况越差，可能面临限流、禁播、封禁等处罚。
            - 违规积分将直接影响账号的曝光量和推荐量。

        ### 累计违规积分对应的惩罚等级：

        | 分数范围  | 惩罚措施                                                | 惩罚时长 |

        | --------- | ---------------------------------------------------------
        | -------- |

        | 9-11      | 警告（Warning）                                           |
        无       |

        | 12-14     | 暂停电商权限（视频、直播、商品展示功能）                  | 24 小时  |

        | 15-17     | 暂停电商权限                                              | 48
        小时  |

        | 18-20     | 暂停电商权限                                              | 72
        小时  |

        | 21-23     | 暂停电商权限                                              | 1
        周     |

        | 24 及以上 | 永久移除电商权限，封禁 TikTok Shop 创作者账号             | 永久禁用 |


        ### 备注:

        - 此接口仅适用于已开通 TikTok Shop 的创作者账号。


        ### 参数:

        - cookie: 用户 Cookie 字符串（用于身份认证）

        - proxy: 可选 HTTP 代理地址，如不使用可省略
            - 示例格式: `http://username:password@host:port`

        ### 返回:

        - `risk_info`（健康状态信息）:
          - `risk_level_text`: 当前风险等级描述（如 Healthy）
          - `light_color`: 健康状态浅色展示色值（rgba 格式）
          - `dark_color`: 健康状态深色展示色值（rgba 格式）
        - `vio_score_rule_learn_url`: 查看违规积分规则说明的链接

        - `is_show_score`: 是否展示违规积分（布尔值）

        - `violation_score`: 当前违规积分数量

        - `creator_status`: 创作者账号状态码（0=正常）


        # [English]

        ### Purpose:

        - Retrieve the health status of a TikTok Shop creator account, including
        the health score over the past 90 days and the current number of
        accumulated violation points.

        - About violation points:
            - Violation points are key metrics used by TikTok to measure the health of a creator account.
            - Higher violation points indicate worse account health, and may lead to restrictions such as reduced exposure, suspension, or account bans.
            - Violation points directly impact the account’s visibility and recommendation on the platform.

        ### Punishment Levels for Accumulated Violation Points:

        | Score Range | Punishment
        Measures                                       | Duration         |

        | ----------- |
        ---------------------------------------------------------- |
        ---------------- |

        | 9-11        |
        Warning                                                     |
        None             |

        | 12-14       | E-commerce permissions suspended (video, live, product
        showcase) | 24 hours         |

        | 15-17       | E-commerce permissions
        suspended                           | 48 hours         |

        | 18-20       | E-commerce permissions
        suspended                           | 72 hours         |

        | 21-23       | E-commerce permissions
        suspended                           | 1 week           |

        | 24+         | Permanent removal of e-commerce permissions and banning
        of TikTok Shop creator account | Permanently disabled |


        ### Notes:

        - This API is only applicable to TikTok Shop creator accounts.


        ### Parameters:

        - cookie: User Cookie string for authentication

        - proxy: Optional HTTP proxy address, can be omitted if not needed
            - Example format: `http://username:password@host:port`

        ### Response:

        - `risk_info`: Account health status:
          - `risk_level_text`: Current health level description (e.g., Healthy)
          - `light_color`: Light color code for health level display (RGBA format)
          - `dark_color`: Dark color code for health level display (RGBA format)
        - `vio_score_rule_learn_url`: URL to learn more about violation point
        rules

        - `is_show_score`: Whether to display violation points (boolean)

        - `violation_score`: Current violation score

        - `creator_status`: Creator account status code (0 = normal)


        # [示例/Example]

        ```json

        payload = {
            "cookie": "your_cookie"
        }
      operationId: >-
        get_account_health_status_api_v1_tiktok_creator_get_account_health_status_post
      tags:
        - TikTok-Creator-API
        - TikTok-Creator-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAccountHealthRequest'
      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: Na_32sSVi2XG0YxfrT60R
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: Na_32sSVi2XG0YxfrT60R
            scopes:
              Na_32sSVi2XG0YxfrT60R:
                HTTPBearer: []
      x-apifox-folder: TikTok-Creator-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-289437011-run
components:
  schemas:
    GetAccountHealthRequest:
      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: ''
      type: object
      title: GetAccountHealthRequest
      x-apifox-orders:
        - cookie
        - proxy
      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: []

```