Xiaohongshu PGY note metrics
Xiaohongshu PGY note metrics: inspect inputs, pgy note metrics fields, pagination and limits, then run a local simulated request.
Copy the agent prompt manually
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.
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.
| Method | Field | Type | Requirement | Meaning | Enum or bound | Example |
|---|---|---|---|---|---|---|
| GET | id | string | Required | Note ID, 24 hexadecimal characters: the part after explore/ in a Xiaohongshu note link, or an id the PGY creator notes endpoint returns | — | "6a20edfa0000000021020951" |
| GET | view | string | Optional / conditional | How much of each item: compact (the most used fields, long text cut short), standard, or full (adds `ext`). | ["compact","standard","full"] | — |
| GET | fields | array | Optional / conditional | Return only these fields of each item, by path (`author.name`). | maxItems: 64 | — |
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.
{
"capability": "xiaohongshu.pgy.notes.get",
"method": "GET",
"params": {
"id": "6a20edfa0000000021020951"
}
}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.
| Field | Type | Meaning | Source scope |
|---|---|---|---|
| id | string | null | Note ID | Xiaohongshu (RedNote) |
| url | string | null | Link to the note, with the access token the platform gives, so it opens as it is | Xiaohongshu (RedNote) |
| type | string | null | An image note or a video note | Xiaohongshu (RedNote) |
| title | string | null | The note's title | Xiaohongshu (RedNote) |
| text | string | null | The note's text (standard view and up) | Xiaohongshu (RedNote) |
| published_at | string | null | When it was published | Xiaohongshu (RedNote) |
| images | array | null | Addresses of the pictures, in the note's order (standard view and up) | Xiaohongshu (RedNote) |
| creator_id | string | null | The creator's PGY creator ID, as the other PGY creator endpoints take it | Xiaohongshu (RedNote) |
| creator_name | string | null | The creator's name | Xiaohongshu (RedNote) |
| brand | string | null | The brand the note was reported as sponsored by, in the platform's words; null when it is no reported sponsored note | Xiaohongshu (RedNote) |
| brand_id | string | null | The Xiaohongshu account ID of that brand; null when there is none (standard view and up) | Xiaohongshu (RedNote) |
| metrics | object | null | The figures PGY gives for the note | Xiaohongshu (RedNote) |
| metrics.impressions | integer | null | Impressions | Xiaohongshu (RedNote) |
| metrics.views | integer | null | Reads | Xiaohongshu (RedNote) |
| metrics.likes | integer | null | Likes | Xiaohongshu (RedNote) |
| metrics.favorites | integer | null | Saves | Xiaohongshu (RedNote) |
| metrics.comments | integer | null | Comments | Xiaohongshu (RedNote) |
| metrics.shares | integer | null | Shares | Xiaohongshu (RedNote) |
| metrics.follows | integer | null | Follows the note brought (new followers gained from it) | Xiaohongshu (RedNote) |
| component_clicks | object | null | 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 (standard view and up) | Xiaohongshu (RedNote) |
| component_clicks.comment_area | string | null | 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 (standard view and up) | Xiaohongshu (RedNote) |
| component_clicks.content | string | null | 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 (standard view and up) | Xiaohongshu (RedNote) |
| component_clicks.note_bottom | string | null | 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 (standard view and up) | Xiaohongshu (RedNote) |
| approximate | array | null | Which numbers of this item are approximate or lower bounds; absent when all are exact | Xiaohongshu (RedNote) |
| approximate[].field | string | null | Path of the field, such as metrics.views | Xiaohongshu (RedNote) |
| approximate[].kind | string | null | Approximate, or a lower bound | Xiaohongshu (RedNote) |
| ext | object | The platform's own fields (full view). | Xiaohongshu (RedNote) |
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.
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 ↗