PGY note detail object

The PGY note detail object has 21 fields and is returned by 1 endpoint on Xiaohongshu (RedNote). A call costs $0.0400. It is a preview structure and may still change.

Preview object · Updated 2026-11-10Open in ChatGPTOpen in Claude

Fields

A field the platform cannot give is left out of the item and named in meta.unavailable. It is never filled with a guess or a zero.

id text

Note ID

url link

Link to the note, with the access token the platform gives, so it opens as it is

type text

An image note or a video note: image video

title text

The note's title

text text standard

The note's text

published_at time

When it was published

images list of link standard

Addresses of the pictures, in the note's order

creator_id text

The creator's PGY creator ID, as the other PGY creator endpoints take it

creator_name text

The creator's name

brand text

The brand the note was reported as sponsored by, in the platform's words; null when it is no reported sponsored note

brand_id text standard

The Xiaohongshu account ID of that brand; null when there is none

metrics object

The figures PGY gives for the note

metrics.impressions integer

Impressions

metrics.views integer

Reads

metrics.likes integer

Likes

metrics.favorites integer

Saves

metrics.comments integer

Comments

metrics.shares integer

Shares

metrics.follows integer

Follows the note brought (new followers gained from it)

component_clicks object standard

The click-through band of each component the brand put in the note (PGY's component clicks); null when the note has no such figures

component_clicks.comment_area text standard

Click-through band of the comment-area component: normal (0-2%), high (2-10%) or very_high (over 10%), as PGY grades it; null when the note carries no such component: normal high very_high

component_clicks.content text standard

Click-through band of the in-text component: normal (0-2%), high (2-10%) or very_high (over 10%), as PGY grades it; null when the note carries no such component: normal high very_high

component_clicks.note_bottom text standard

Click-through band of the component at the bottom of the note: normal (0-2%), high (2-10%) or very_high (over 10%), as PGY grades it; null when the note carries no such component: normal high very_high

Endpoints that return PGY note detail

The number beside each platform is how many of its endpoints return it.

EndpointPathPrice
Xiaohongshu PGY note metricsGET/v1/xiaohongshu/pgy/notes/get$0.0400

Example

One item from xiaohongshu.pgy.notes.get, as recorded 2026-11-10 19:33 UTC. Names, text, IDs and links are examples; the figures are as recorded.

PGY note detail · xiaohongshu.pgy.notes.get
{
  "id": "6aa68ad700000000cc4e240a",
  "url": "https://www.xiaohongshu.com/explore/6aa68ad700000000cc4e240a",
  "type": "image",
  "title": "关于周末露营,我踩过的五个坑",
  "text": "周末的周末露营日常,随手记录一下",
  "published_at": "2026-11-06T08:58:31.000Z",
  "images": [
    "https://sns-webpic-qc.xhscdn.com/20261013/8f1dc0a9ba488c20db59!nd_dft_wlteh_webp_3",
    "https://sns-webpic-qc.xhscdn.com/20261013/13bf10108e7eae003580!nd_dft_wlteh_webp_3",
    // … 13 more
  ],
  "creator_id": "6a72df4700000000f893a8a0",
  "creator_name": "周末露营这件事,越简单越好",
  "brand": "把周末露营从头到尾讲清楚,看完少走弯路",
  "brand_id": "6659928c00000000428fe21c",
  "metrics": {
    "impressions": 24405,
    "views": 4482,
    "likes": 203,
    "favorites": 171,
    "comments": 46,
    "shares": 36,
    "follows": 22
  },
  "component_clicks": {
    "comment_area": "normal",
    "content": null,
    "note_bottom": null
  }
}

The whole response is on the endpoint's page →

Related

Other objects