# 获取创作者账号诊断/Fetch author diagnosis

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/douyin/creator_v2/fetch_author_diagnosis:
    post:
      summary: 获取创作者账号诊断/Fetch author diagnosis
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取抖音创作者账号的诊断数据和优化建议

        - 自动分析最近一周（从当天起往前7天）的账号表现

        - 提供完播率、互动指数等关键指标的评估和改进建议

        - 帮助创作者了解账号健康度，优化内容策略

        - **此接口需要用户提供有效的抖音创作者平台Cookie**

        - **使用 POST 方法，Cookie 在请求体中传输，更安全**

        - **无需指定时间范围，系统自动获取最近7天数据**


        ### 请求体参数:

        - cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）


        ### 数据更新时间:

        - **更新周期**: 次日12点更新昨日作品数据

        - **示例**: 2025年10月10日的作品数据会在2025年10月11日12点更新

        - **时间范围**: 自动获取最近一周的数据（从当天起往前7天）

        - **首次使用**: 获取权限后次日起生产数据


        ### 数据指标含义:


        **名词定义**:

        - **同类创作者**: 具有相似创作领域或粉丝量级的创作者

        - **时间粒度**: 时间粒度是数据更新计算的周期

        - **抖音精选**: 包含精选APP+抖音电脑端+抖音APP_精选Tab的数据表现


        **账号诊断类指标**:

        - **投稿数**: 根据统计周期内发布的作品个数得出

        - **互动指数**: 作品的观看、点赞、评论、转发的综合得分

        - **视频播放量**: 作品被观看的次数

        - **视频完播率**: 作品完整播放次数的占比
          - 每日完播率：当日完播浏览量与总浏览量的比值
          - 每十分钟级完播率：累计完播浏览量与累计浏览量的比值
        - **粉丝净增量**: 账号净增粉丝数，通过涨粉数减去掉粉数得出


        ### 返回数据说明:

        返回账号诊断数据，包括以下五个核心维度：


        **1. 互动指数 (Interact)**:

        - **OwnValue**: 账号自身的互动指数值（观看、点赞、评论、转发的综合得分）

        - **SimilarCount**: 同类创作者总数

        - **AuthorRank**: 账号在自身历史数据中的排名百分位（0-1之间，越大表示当前表现越好）

        - **SimilarRank**: 账号在同类创作者中的排名百分位（0-1之间，越大表示排名越靠前）

        - **SimilarValue**: 同类创作者的平均互动指数值

        - **解读**: AuthorRank=0.26表示当前互动指数超过了自己历史26%的时期

        - **解读**: SimilarRank=0.52表示在同类创作者中排名超过52%


        **2. 粉丝净增量 (NewFans)**:

        - **OwnValue**: 统计周期内账号净增粉丝数（涨粉数 - 掉粉数）

        - **SimilarCount**: 同类创作者总数

        - **AuthorRank**: 账号在自身历史涨粉数据中的排名百分位

        - **SimilarRank**: 账号在同类创作者中的涨粉排名百分位

        - **SimilarValue**: 同类创作者的平均粉丝净增量

        - **解读**: OwnValue=2表示本周期净增2个粉丝


        **3. 视频播放量 (PlayCnt)**:

        - **OwnValue**: 统计周期内作品被观看的总次数

        - **SimilarCount**: 同类创作者总数

        - **AuthorRank**: 账号在自身历史播放量中的排名百分位

        - **SimilarRank**: 账号在同类创作者中的播放量排名百分位

        - **SimilarValue**: 同类创作者的平均播放量

        - **解读**: OwnValue=192表示本周期总播放量为192次


        **4. 视频完播率 (PlayFinishRatio)**:

        - **OwnValue**: 作品完整播放次数的占比（0-1之间的小数）

        - **SimilarCount**: 同类创作者总数

        - **AuthorRank**: 账号在自身历史完播率中的排名百分位

        - **SimilarRank**: 账号在同类创作者中的完播率排名百分位

        - **SimilarValue**: 同类创作者的平均完播率

        - **解读**: OwnValue=0.15表示完播率为15%

        - **提升建议**: "想要作品吸引人，前3秒钟是关键，可以多分析同行业热门作品的人设、镜头技巧和音乐"


        **5. 投稿活跃度 (PublishActivation)**:

        - **OwnValue**: 统计周期内发布的作品个数

        - **SimilarCount**: 同类创作者总数

        - **AuthorRank**: 账号在自身历史投稿数据中的排名百分位

        - **SimilarRank**: 账号在同类创作者中的投稿活跃度排名百分位

        - **SimilarValue**: 同类创作者的平均投稿数

        - **解读**: OwnValue=2表示本周期发布了2个作品


        ### 返回数据结构示例:

        ```json

        {
            "code": 0,
            "data": {
                "Interact": {
                    "OwnValue": 0.0052,
                    "SimilarCount": 1494654282,
                    "AuthorRank": 0.2633,
                    "SimilarRank": 0.5169,
                    "SimilarValue": 0.0909
                },
                "NewFans": {
                    "OwnValue": 2,
                    "AuthorRank": 0.7924,
                    "SimilarRank": 0.6343
                },
                "PlayCnt": {
                    "OwnValue": 192,
                    "AuthorRank": 0.8427,
                    "SimilarRank": 0.5132
                },
                "PlayFinishRatio": {
                    "OwnValue": 0.1545,
                    "AuthorRank": 0.3851,
                    "SimilarRank": 0.5086
                },
                "PublishActivation": {
                    "OwnValue": 2,
                    "AuthorRank": 0.7345,
                    "SimilarRank": 0.5675
                }
            }
        }

        ```


        ### 数据解读技巧:

        - **OwnValue**: 查看实际数值，了解账号当前表现

        - **AuthorRank**: 与自己过去比较，数值越高说明当前状态越好

        - **SimilarRank**: 与同行比较，数值越高说明在同类创作者中排名越靠前

        - **建议**: AuthorRank和SimilarRank都低于0.5时需要重点优化该项指标


        ### Cookie 获取方式:

        1. 登录抖音创作者平台 (https://creator.douyin.com)

        2. 打开浏览器开发者工具（F12）

        3. 切换到 Network 标签

        4. 刷新页面或进行操作

        5. 找到任意请求，复制 Cookie 请求头的值


        # [English]

        ### Purpose:

        - Get Douyin creator account diagnosis data and optimization suggestions

        - Automatically analyze account performance for the past 7 days

        - Provide assessment and improvement suggestions for key metrics

        - Help creators understand account health and optimize content strategy

        - **This API requires valid Douyin Creator Platform Cookie**

        - **Use POST method, Cookie transmitted in request body, more secure**

        - **No need to specify time range, system automatically fetches data for
        past 7 days**


        ### Request Body Parameters:

        - cookie: User's Douyin Creator Platform Cookie (required)


        ### Data Update Time:

        - **Update Cycle**: Yesterday's video data is updated at 12:00 noon the
        next day

        - **Example**: Video data from October 10, 2025 will be updated at 12:00
        on October 11, 2025

        - **Time Range**: Automatically fetches data for the past 7 days

        - **First Use**: Data generation starts from the next day after
        obtaining permission


        ### Data Metrics Definition:


        **Term Definitions**:

        - **Similar Creators**: Creators with similar creation fields or fan
        levels

        - **Time Granularity**: The period for data update calculations

        - **Douyin Featured**: Data performance including Featured APP + Douyin
        Desktop + Douyin APP Featured Tab


        **Account Diagnosis Metrics**:

        - **Submission Count**: Number of works published during the statistical
        period

        - **Engagement Index**: Comprehensive score of views, likes, comments,
        and shares

        - **Video Views**: Number of times the work has been viewed

        - **Video Completion Rate**: Proportion of complete playbacks
          - Daily completion rate: Ratio of daily complete views to total views
          - 10-minute completion rate: Ratio of cumulative complete views to cumulative views
        - **Net Fan Growth**: Net increase in account followers (new followers
        minus unfollowers)


        ### Return Data Description:

        Account diagnosis data including five core dimensions:


        **1. Engagement Index (Interact)**:

        - **OwnValue**: Account's own engagement index value (comprehensive
        score of views, likes, comments, shares)

        - **SimilarCount**: Total number of similar creators

        - **AuthorRank**: Ranking percentile in account's historical data (0-1,
        higher means better current performance)

        - **SimilarRank**: Ranking percentile among similar creators (0-1,
        higher means better ranking)

        - **SimilarValue**: Average engagement index value of similar creators

        - **Interpretation**: AuthorRank=0.26 means current engagement exceeds
        26% of own history

        - **Interpretation**: SimilarRank=0.52 means ranking exceeds 52% of
        similar creators


        **2. Net Fan Growth (NewFans)**:

        - **OwnValue**: Net increase in followers during the period (new
        followers - unfollowers)

        - **SimilarCount**: Total number of similar creators

        - **AuthorRank**: Ranking percentile in account's historical fan growth
        data

        - **SimilarRank**: Fan growth ranking percentile among similar creators

        - **SimilarValue**: Average net fan growth of similar creators

        - **Interpretation**: OwnValue=2 means net gain of 2 followers in this
        period


        **3. Video Views (PlayCnt)**:

        - **OwnValue**: Total number of times works were viewed during the
        period

        - **SimilarCount**: Total number of similar creators

        - **AuthorRank**: Ranking percentile in account's historical view count

        - **SimilarRank**: View count ranking percentile among similar creators

        - **SimilarValue**: Average view count of similar creators

        - **Interpretation**: OwnValue=192 means total views of 192 in this
        period


        **4. Video Completion Rate (PlayFinishRatio)**:

        - **OwnValue**: Proportion of complete playbacks (decimal between 0-1)

        - **SimilarCount**: Total number of similar creators

        - **AuthorRank**: Ranking percentile in account's historical completion
        rate

        - **SimilarRank**: Completion rate ranking percentile among similar
        creators

        - **SimilarValue**: Average completion rate of similar creators

        - **Interpretation**: OwnValue=0.15 means 15% completion rate

        - **Tip**: Focus on first 3 seconds to improve retention


        **5. Publishing Activity (PublishActivation)**:

        - **OwnValue**: Number of works published during the period

        - **SimilarCount**: Total number of similar creators

        - **AuthorRank**: Ranking percentile in account's historical publishing
        data

        - **SimilarRank**: Publishing activity ranking percentile among similar
        creators

        - **SimilarValue**: Average number of submissions by similar creators

        - **Interpretation**: OwnValue=2 means published 2 works in this period


        ### Return Data Structure Example:

        ```json

        {
            "code": 0,
            "data": {
                "Interact": {
                    "OwnValue": 0.0052,
                    "SimilarCount": 1494654282,
                    "AuthorRank": 0.2633,
                    "SimilarRank": 0.5169,
                    "SimilarValue": 0.0909
                },
                "NewFans": {
                    "OwnValue": 2,
                    "AuthorRank": 0.7924,
                    "SimilarRank": 0.6343
                },
                "PlayCnt": {
                    "OwnValue": 192,
                    "AuthorRank": 0.8427,
                    "SimilarRank": 0.5132
                },
                "PlayFinishRatio": {
                    "OwnValue": 0.1545,
                    "AuthorRank": 0.3851,
                    "SimilarRank": 0.5086
                },
                "PublishActivation": {
                    "OwnValue": 2,
                    "AuthorRank": 0.7345,
                    "SimilarRank": 0.5675
                }
            }
        }

        ```


        ### Data Interpretation Tips:

        - **OwnValue**: Check actual values to understand current account
        performance

        - **AuthorRank**: Compare with own past, higher value means better
        current status

        - **SimilarRank**: Compare with peers, higher value means better ranking
        among similar creators

        - **Recommendation**: Focus on optimizing metrics when both AuthorRank
        and SimilarRank are below 0.5


        ### How to get Cookie:

        1. Login to Douyin Creator Platform (https://creator.douyin.com)

        2. Open browser developer tools (F12)

        3. Switch to Network tab

        4. Refresh page or perform operations

        5. Copy the Cookie header value


        # [示例/Example]

        ```json

        {
            "cookie": "Your_Cookie_Here"
        }

        ```
      operationId: >-
        fetch_author_diagnosis_api_v1_douyin_creator_v2_fetch_author_diagnosis_post
      tags:
        - Douyin-Creator-V2-API
        - Douyin-Creator-V2-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthorDiagnosisRequest'
              description: 创作者账号诊断请求参数/Author diagnosis request parameters
            example:
              cookie: Your_Cookie_Here
      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: OfZcJkE7QhXmGmpa1v_Ho
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: OfZcJkE7QhXmGmpa1v_Ho
            scopes:
              OfZcJkE7QhXmGmpa1v_Ho:
                HTTPBearer: []
      x-apifox-folder: Douyin-Creator-V2-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-359719874-run
components:
  schemas:
    AuthorDiagnosisRequest:
      properties:
        cookie:
          type: string
          title: Cookie
          description: 用户Cookie/User Cookie
          examples:
            - Your_Cookie_Here
      type: object
      required:
        - cookie
      title: AuthorDiagnosisRequest
      description: >-
        创作者账号诊断请求模型

        Author Diagnosis Request Model


        此接口无需额外参数，自动获取最近一周（从当天起往前7天）的账号诊断数据

        This API requires no additional parameters, automatically fetches
        diagnosis data for the past 7 days
      x-apifox-orders:
        - cookie
      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: []

```
