PgyNote object

One note as PGY shows it: text, pictures, creator, sponsoring brand and figures. The same fields on every platform. A field a platform does not show is null, and meta.unavailable names it with the reason.

Field	Type	From view	Description
`id`	string	compact	Note ID.
`url`	string \| null	compact	Link to the note, with the access token that makes it open.
`type`	string \| null	compact	Image note or video note.
`title`	string \| null	compact	The note's title.
`text`	string \| null	standard	The note's text. · may be cut in compact
`published_at`	string \| null	compact	When it was published.
`images`	string[] \| null	standard	Picture links in order.
`creator_id`	string \| null	compact	The creator's PGY ID.
`creator_name`	string \| null	compact	The creator's name.
`brand`	string \| null	compact	The sponsoring brand, in the platform's words; null when it is not a reported sponsored note.
`brand_id`	string \| null	standard	That brand's Xiaohongshu account ID; null when none.
`metrics`	PgyNoteMetrics	compact	The note's figures on PGY.
`component_clicks`	PgyComponentClicks \| null	standard	Click-through bands of the components the brand added; null when there are none.
`ext`	object	full	Platform-specific extras. Only returned with view=full. · only with view=full

PgyNoteMetrics

Field	Type	Description
`impressions`	integer \| null	Impressions.
`views`	integer \| null	Reads.
`likes`	integer \| null	Likes.
`favorites`	integer \| null	Saves.
`comments`	integer \| null	Comments.
`shares`	integer \| null	Shares.
`follows`	integer \| null	New followers the note brought.

PgyComponentClicks

Field	Type	Description
`comment_area`	string \| null	Click-through band of the comment-area component: normal (under 2%), high (2-10%) or very_high (over 10%); null when the note has none.
`content`	string \| null	Click-through band of the in-text component: normal (under 2%), high (2-10%) or very_high (over 10%); null when the note has none.
`note_bottom`	string \| null	Click-through band of the component at the end of the note: normal (under 2%), high (2-10%) or very_high (over 10%); null when the note has none.

Example · xiaohongshu

{
  "id": null,
  "url": null,
  "type": null,
  "title": null,
  "text": null,
  "published_at": null,
  "images": null,
  "creator_id": null,
  "creator_name": null,
  "brand": null,
  "brand_id": null,
  "metrics": {
    "impressions": null,
    "views": null,
    "likes": null,
    "favorites": null,
    "comments": null,
    "shares": null,
    "follows": null
  },
  "component_clicks": {
    "comment_area": null,
    "content": null,
    "note_bottom": null
  }
}

Endpoints that return a PgyNote

Xiaohongshu PGY note figuresxiaohongshu.pgy.notes.getPgyNote$0.04/call

PgyNoteMetrics

PgyComponentClicks

Endpoints that return a PgyNote

Connect once, then just ask.