DataNavoAPI / APIS / REDNOTE

Xiaohongshu PGY note metrics

Xiaohongshu PGY note metrics: inspect inputs, pgy note metrics fields, pagination and limits, then run a local simulated request.

LOCAL SIMULATIONAll displayed records are fictional fixtures. Live APIs, payments and external email are disabled.中文版 ↗
01

What this capability does

Xiaohongshu PGY note metrics uses /v1/xiaohongshu/pgy/notes/get; GET returns data.item with pgy note metrics objects.

This is a local simulation. Program-generated samples are not live platform data and do not establish provider availability.

  • Capability: xiaohongshu.pgy.notes.get
  • Pagination: no cursor pagination; do not repeatedly request another page.
02

Input contract

Inspect meanings, examples and conditional rules for the selected method. view and fields control the response without changing the TEST unit price.

  • Only send fields defined for this method; unknown fields are rejected before execution.
MethodFieldTypeRequirementMeaningEnum or boundExample
GETidstringRequiredNote ID, 24 hexadecimal characters: the part after explore/ in a Xiaohongshu note link, or an id the PGY creator notes endpoint returns—"6a20edfa0000000021020951"
GETviewstringOptional / conditionalHow much of each item: compact (the most used fields, long text cut short), standard, or full (adds `ext`).["compact","standard","full"]—
GETfieldsarrayOptional / conditionalReturn only these fields of each item, by path (`author.name`).maxItems: 64—
03

Try it locally

Use demo to inspect the fields, then explicitly select simulated with a customer test key to exercise settlement. Never put a customer key in a URL.

json
{
  "capability": "xiaohongshu.pgy.notes.get",
  "method": "GET",
  "params": {
    "id": "6a20edfa0000000021020951"
  }
}
04

Output fields and interpretation

The pgy_note object permits missing or null values; do not replace missing measurements with zero. This table shows the main structure; the object reference covers nested fields.

FieldTypeMeaningSource scope
idstring | nullNote IDXiaohongshu (RedNote)
urlstring | nullLink to the note, with the access token the platform gives, so it opens as it isXiaohongshu (RedNote)
typestring | nullAn image note or a video noteXiaohongshu (RedNote)
titlestring | nullThe note's titleXiaohongshu (RedNote)
textstring | nullThe note's text (standard view and up)Xiaohongshu (RedNote)
published_atstring | nullWhen it was publishedXiaohongshu (RedNote)
imagesarray | nullAddresses of the pictures, in the note's order (standard view and up)Xiaohongshu (RedNote)
creator_idstring | nullThe creator's PGY creator ID, as the other PGY creator endpoints take itXiaohongshu (RedNote)
creator_namestring | nullThe creator's nameXiaohongshu (RedNote)
brandstring | nullThe brand the note was reported as sponsored by, in the platform's words; null when it is no reported sponsored noteXiaohongshu (RedNote)
brand_idstring | nullThe Xiaohongshu account ID of that brand; null when there is none (standard view and up)Xiaohongshu (RedNote)
metricsobject | nullThe figures PGY gives for the noteXiaohongshu (RedNote)
metrics.impressionsinteger | nullImpressionsXiaohongshu (RedNote)
metrics.viewsinteger | nullReadsXiaohongshu (RedNote)
metrics.likesinteger | nullLikesXiaohongshu (RedNote)
metrics.favoritesinteger | nullSavesXiaohongshu (RedNote)
metrics.commentsinteger | nullCommentsXiaohongshu (RedNote)
metrics.sharesinteger | nullSharesXiaohongshu (RedNote)
metrics.followsinteger | nullFollows the note brought (new followers gained from it)Xiaohongshu (RedNote)
component_clicksobject | nullThe click-through band of each component the brand put in the note (PGY's component clicks); null when the note has no such figures (standard view and up)Xiaohongshu (RedNote)
component_clicks.comment_areastring | nullClick-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 (standard view and up)Xiaohongshu (RedNote)
component_clicks.contentstring | nullClick-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 (standard view and up)Xiaohongshu (RedNote)
component_clicks.note_bottomstring | nullClick-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 (standard view and up)Xiaohongshu (RedNote)
approximatearray | nullWhich numbers of this item are approximate or lower bounds; absent when all are exactXiaohongshu (RedNote)
approximate[].fieldstring | nullPath of the field, such as metrics.viewsXiaohongshu (RedNote)
approximate[].kindstring | nullApproximate, or a lower boundXiaohongshu (RedNote)
extobjectThe platform's own fields (full view).Xiaohongshu (RedNote)
05

Unavailable fields

These published contract notes describe the capability boundary; fixtures do not establish live availability.

FieldReason
06

Limits and checks

A successful request does not establish full coverage. Preserve the request ID, observation time, parameters and cursor, and inspect the returned items before analysis.

Local simulation uses TEST credits only. Real provider calls, real payments and external email are disabled. Historical reference-site prices are not DataNavoAPI prices.

  • Verify media URLs, counts and optional fields individually.
TRY THE CONTRACT

Clear inputs. Inspectable output.

Each click runs a local fixture. Advanced JSON inputs are checked against the selected method. Editing does not execute a request.

Copying does not execute. CLI quote is read-only and needs a local customer TEST key. Configure MCP in demo mode first. GET and POST batches both return only fictional local fixtures.

Download contract example (no execution) ↗

For TEST budgets, Key scopes or failure scenarios, open the account console. Customer sandbox ↗