Xiaohongshu-PGY-API

获取蒲公英博主数据概览/Get PGY blogger data summary

Changed on

[中文]

用途:

  • 获取博主账号维度的数据概览汇总

请求体参数:

  • user_id: 必填,博主用户ID
  • business: 笔记口径,0=日常笔记(默认) 1=合作笔记

返回:

  • 成本/报价预估: estimatePictureCpm / estimateVideoCpm / pictureReadCost 等
  • 服务表现: 近 7 天活跃天数、邀约 48 小时回复率
  • 成长表现: 粉丝量变化幅度及其同行百分位

响应结构(取数要剥两层):

  • resp["data"] 是蒲公英原样信封(含 code/msg/success),业务数据还在它里面一层
  • 正确取法:data = resp["data"]["data"];下面「返回」列的字段都在这一层下

计费:

  • HTTP 200 → 计费。包含「查无结果」(data 为 null,如 ID 不存在或筛选无命中)—— 请求已送达蒲公英,同样扣费,不要因为拿不到数据就重试
  • HTTP 400 → 不计费(参数格式非法,或上游资源不足/异常)

[English]

Purpose:

  • Account-level data summary of a blogger

Request Body Parameters:

  • user_id: required, blogger user ID
  • business: 0=organic (default), 1=sponsored

Return:

  • Cost/quote estimates: estimatePictureCpm / estimateVideoCpm / pictureReadCost
  • Service metrics: active days in last 7d, 48h invitation reply rate
  • Growth: fans change rate and percentile vs peers

Response shape (two layers):

  • resp["data"] is PGY's raw envelope (with code/msg/success); the payload is one level deeper
  • Correct access: data = resp["data"]["data"] — every field listed under "Return" lives here

Billing:

  • HTTP 200 → charged, including "no result" (data is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota
  • HTTP 400 → not charged (malformed params, or upstream unavailable/error)

[示例/Example]

// ① 日常笔记口径
{"user_id": "5c668b3e0000000012021605"}

// ② 合作笔记口径(按商单价格评估性价比时用这个)
{"user_id": "5c668b3e0000000012021605", "business": 1}

两种口径的成本类指标不同 —— 实测同一博主日常图文 CPM ≈11、合作口径 ≈19。 想评估「按商单价格算的性价比」请传 business=1。

The two modes yield different cost metrics; pass business=1 to evaluate sponsored-price ROI.

post/api/v1/xiaohongshu/pgy/get_blogger_data_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

user_idstring required

博主用户ID/Blogger user ID

business0 | 1

笔记口径 0=日常笔记(默认) 1=合作笔记/Note scope

Example request

{
  "user_id": "5c668b3e0000000012021605"
}

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