Xiaohongshu-PGY-API

获取蒲公英博主数据表现/Get PGY blogger performance metrics

Changed on

[中文]

用途:

  • 获取博主笔记的整体数据表现,用于评估内容质量与稳定性
  • 对应博主主页「数据概览 → 笔记数据」与「笔记数据 → 数据表现」

请求体参数:

  • user_id: 必填,博主用户ID
  • business: 笔记口径,0=日常笔记(默认) 1=合作笔记
  • note_type: 笔记类型,3=图文+视频(默认) 1=图文 2=视频 注意: 与 /get_blogger_notes 的同名参数取值不同(那个是 4=全部 3=合作笔记)
  • date_type: 时间范围,1=近30日(默认) 2=近90日
  • advertise_switch: 流量类型,1=全部(含合作,默认) 0=仅自然流量

返回:

  • 各项中位数: impMedian(曝光) / readMedian(阅读) / interactionMedian(互动)
  • 比率: 互动率、完播率、百赞/千赞笔记比例
  • 超越同行的百分位(如 impMedianBeyondRate)

提示:

  • 想看「这个博主接商单时表现如何」,把 business 设为 1,再与 0 的结果对比

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

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

计费:

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

[English]

Purpose:

  • Overall content performance of a blogger, for judging quality and consistency

Request Body Parameters:

  • user_id: required, blogger user ID
  • business: note scope, 0=organic (default), 1=sponsored
  • note_type: 3=image-text+video (default), 1=image-text, 2=video Warning: differs from /get_blogger_notes, where 4=all and 3=sponsored
  • date_type: 1=last 30 days (default), 2=last 90 days
  • advertise_switch: 1=all traffic (default), 0=organic only

Return:

  • Medians: impMedian / readMedian / interactionMedian
  • Rates: engagement rate, completion rate, 100-like / 1000-like note ratio
  • Percentile vs peers (e.g. impMedianBeyondRate)

Tip:

  • Set business=1 and compare against business=0 to see how the blogger performs on sponsored content

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"}

// 合作笔记(商单)表现,近 90 日
{"user_id": "5c668b3e0000000012021605", "business": 1, "date_type": 2}
post/api/v1/xiaohongshu/pgy/get_blogger_notes_rate

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: 0=organic, 1=sponsored

note_type1 | 2 | 3

笔记类型 3=图文+视频(默认) 1=图文 2=视频/Note type

date_type1 | 2

时间范围 1=近30日(默认) 2=近90日/Date range: 1=last 30d, 2=last 90d

advertise_switch0 | 1

流量类型 1=全部(含合作) 0=仅自然流量/Traffic type

Example request

{
  "user_id": "5c668b3e0000000012021605",
  "note_type": 3,
  "date_type": 1,
  "advertise_switch": 1
}

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