Skip to main content
POST
Reference example
获取创作者账号诊断 计费 — 按成功调用计费,最终扣费按你的套餐倍率浮动。仅当上游响应体 code 为 200 时计费。
响应结构尚未完整文档化 —— 以实际调用为准。

示例

请求规范

完整 OpenAPI 定义 有效请求与价格声明(包括认证和引用的 schema):

费用与请求规则

公开参考价格:每次成功请求 $0.001 USD。 最终费用以账户适用价格及实际结算为准。 公开参考值不是你的账户报价或最终扣费。对于支持 X-AISA-Cost-Mode: quote 的接口,执行前请针对完整请求获取免费报价;执行后通过响应费用元数据和 Usage Logs 核对结算费用。1 USD 等于 1,000,000 个整数 micro-USD。
  • 默认请求参考估价(USD): 0.001
  • 计费依据: fixed_success
  • 公开参考倍率: 1.0
  • 结算证据来源: request_snapshot

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json

Author diagnosis request parameters

User's Douyin Creator Platform Cookie (required)

示例:

"Your_Cookie_Here"

响应

Successful response. The outer object follows ResponseModel; the endpoint-specific payload is in data.

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

cache_message
string | null
默认值: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 (EN-US)

cache_message_zh
string | null
默认值:本次响应已缓存,可通过下方 URL 直接查看,有效期 24 小时,访问缓存链接无额外费用。缓存仅用于请求溯源,不影响接口数据的时效性,也不会再次通过接口返回。

Cache message (ZH-CN)

cache_url
string | null

The URL to access the cached result

code
integer
默认值:200

HTTP 状态码

data
any

Endpoint-specific response payload. The official shared model does not declare a fixed type or field set. Use the operation's documented return fields or response example; an operation-specific schema, when present, describes the documented fields. Undocumented fields must be read from the actual response rather than assumed.

docs
string | null

Link to the API Swagger documentation for this endpoint

message
string
默认值:Request successful. This request will incur a charge.

Response message (EN-US)

message_zh
string
默认值:请求成功,本次请求将被计费。

Response message (ZH-CN)

params
any
默认值:{}

The parameters used in the request

request_id
string | null

Unique request identifier

router
string
默认值:""

The endpoint that generated this response

support
string
默认值:Discord: https://discord.gg/aMEAS8Xsvz

Support message

time
string

The time the response was generated

time_stamp
integer

The timestamp the response was generated

time_zone
string
默认值:America/Los_Angeles

The timezone of the response time