Xiaohongshu PGY creator metrics
Xiaohongshu PGY creator metrics: inspect inputs, pgy creator metrics fields, pagination and limits, then run a local simulated request.
Copy the agent prompt manually
What this capability does
Xiaohongshu PGY creator metrics uses /v1/xiaohongshu/pgy/creators/metrics; GET returns data.item with pgy creator metrics objects.
This is a local simulation. Program-generated samples are not live platform data and do not establish provider availability.
- Capability: xiaohongshu.pgy.creators.metrics
- 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 | PGY creator ID, 24 hexadecimal characters; take it from the PGY creator search | — | "5c0017ef6b58b740c92463fb" |
| GET | window | string | Optional / conditional | The period: the last 30 or the last 90 days | ["30d","90d"] | — |
| GET | tab | string | Optional / conditional | Whose figures: everyday for the creator's everyday notes, sponsored for the sponsored ones; everyday by default, as the two tabs of the creator's PGY page | ["everyday","sponsored"] | — |
| 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.creators.metrics",
"method": "GET",
"params": {
"id": "5c0017ef6b58b740c92463fb"
}
}Output fields and interpretation
The pgy_creator_metrics 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 |
|---|---|---|---|
| creator_id | string | null | PGY creator ID | Xiaohongshu (RedNote) |
| notes | integer | null | Notes in the period | Xiaohongshu (RedNote) |
| median_impressions | integer | null | Median impressions of a note | Xiaohongshu (RedNote) |
| median_reads | integer | null | Median reads of a note | Xiaohongshu (RedNote) |
| median_engagements | integer | null | Median interactions of a note | Xiaohongshu (RedNote) |
| median_likes | integer | null | Median likes of a note (standard view and up) | Xiaohongshu (RedNote) |
| median_favorites | integer | null | Median saves of a note (standard view and up) | Xiaohongshu (RedNote) |
| median_comments | integer | null | Median comments of a note (standard view and up) | Xiaohongshu (RedNote) |
| median_shares | integer | null | Median shares of a note (standard view and up) | Xiaohongshu (RedNote) |
| engagement_rate | number | null | Engagement rate, 0 to 1 | Xiaohongshu (RedNote) |
| video_completion_rate | number | null | Completion rate of video notes, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| image_3s_read_rate | number | null | Share of image-note reads that last 3 seconds, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| hundred_like_share | number | null | Share of notes with 100 likes or more, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| thousand_like_share | number | null | Share of notes with 1,000 likes or more, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| impressions_percentile | number | null | Share of comparable creators whose median impressions it exceeds, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| reads_percentile | number | null | Share of comparable creators whose median reads it exceeds, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| engagements_percentile | number | null | Share of comparable creators whose median interactions it exceeds, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| video_notes | integer | null | Video notes in the period (counted in notes too) (standard view and up) | Xiaohongshu (RedNote) |
| video_completion_percentile | number | null | Share of comparable creators whose video completion rate it exceeds, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| median_follows | integer | null | Median follows a note brought (new followers gained from it) (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources | object | null | Where the period's notes got their traffic: the share of impressions and of reads from each entry point (PGY's traffic sources); each set adds up to 1 (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.impressions | object | null | Shares of the impressions (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.impressions.homefeed | number | null | Share of the impressions from the explore feed, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.impressions.search | number | null | Share of the impressions from search, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.impressions.follow | number | null | Share of the impressions from the following feed, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.impressions.detail | number | null | Share of the impressions from note detail pages, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.impressions.nearby | number | null | Share of the impressions from the nearby feed, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.impressions.other | number | null | Share of the impressions from anywhere else, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.reads | object | null | Shares of the reads (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.reads.homefeed | number | null | Share of the reads from the explore feed, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.reads.search | number | null | Share of the reads from search, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.reads.follow | number | null | Share of the reads from the following feed, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.reads.detail | number | null | Share of the reads from note detail pages, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.reads.nearby | number | null | Share of the reads from the nearby feed, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| traffic_sources.reads.other | number | null | Share of the reads from anywhere else, 0 to 1 (standard view and up) | Xiaohongshu (RedNote) |
| long_term | object | null | Long-term performance (PGY's long-term notes): the notes published in a two-month span about half a year back, whose reads the platform splits into a "recent" part after publication and a "long-term" part after that, each with reads, the standing among peers and where the reads came from. Of the everyday notes with tab=everyday, of the sponsored ones with tab=sponsored. The platform does not say where the two parts divide (full view) | Xiaohongshu (RedNote) |
| long_term.published_from | string | null | First publication day of these notes: a calendar day in China time (UTC+8), written as midnight UTC of its date (full view) | Xiaohongshu (RedNote) |
| long_term.published_to | string | null | Last publication day of these notes, written the same way (full view) | Xiaohongshu (RedNote) |
| long_term.notes | integer | null | Notes published in that span; with 0, everything below is null (full view) | Xiaohongshu (RedNote) |
| long_term.recent_reads | integer | null | Recent reads: a figure of one note, the platform's representative value (of the same order as this endpoint's median reads; the platform does not say whether it is a median or a mean) (full view) | Xiaohongshu (RedNote) |
| long_term.recent_reads_percentile | number | null | Share of comparable creators whose recent reads it exceeds, 0 to 1 (full view) | Xiaohongshu (RedNote) |
| long_term.long_term_reads | integer | null | Long-term reads: a figure of one note, as recent reads (full view) | Xiaohongshu (RedNote) |
| long_term.long_term_reads_percentile | number | null | Share of comparable creators whose long-term reads it exceeds, 0 to 1 (full view) | Xiaohongshu (RedNote) |
| long_term.recent_sources | object | null | Where the recent reads came from, shares adding up to 1 (full view) | Xiaohongshu (RedNote) |
| long_term.recent_sources.homefeed | number | null | Share of the recent reads from the explore feed, 0 to 1 (full view) | Xiaohongshu (RedNote) |
| long_term.recent_sources.search | number | null | Share of the recent reads from search, 0 to 1 (full view) | Xiaohongshu (RedNote) |
| long_term.recent_sources.profile | number | null | Share of the recent reads from the creator's profile page, 0 to 1 (full view) | Xiaohongshu (RedNote) |
| long_term.recent_sources.follow | number | null | Share of the recent reads from the following feed, 0 to 1 (full view) | Xiaohongshu (RedNote) |
| long_term.recent_sources.other | number | null | Share of the recent reads from anywhere else, 0 to 1 (full view) | Xiaohongshu (RedNote) |
| long_term.long_term_sources | object | null | Where the long-term reads came from, shares adding up to 1 (full view) | Xiaohongshu (RedNote) |
| long_term.long_term_sources.homefeed | number | null | Share of the long-term reads from the explore feed, 0 to 1 (full view) | Xiaohongshu (RedNote) |
| long_term.long_term_sources.search | number | null | Share of the long-term reads from search, 0 to 1 (full view) | Xiaohongshu (RedNote) |
| long_term.long_term_sources.profile | number | null | Share of the long-term reads from the creator's profile page, 0 to 1 (full view) | Xiaohongshu (RedNote) |
| long_term.long_term_sources.follow | number | null | Share of the long-term reads from the following feed, 0 to 1 (full view) | Xiaohongshu (RedNote) |
| long_term.long_term_sources.other | number | null | Share of the long-term reads from anywhere else, 0 to 1 (full view) | Xiaohongshu (RedNote) |
| note_list | array | null | The period's notes one by one, oldest first; 15 at most (recorded: 15 given of 34 in the period); null when the period has no note (full view) | Xiaohongshu (RedNote) |
| note_list[].id | string | null | Note ID (full view) | Xiaohongshu (RedNote) |
| note_list[].title | string | null | The note's title (full view) | Xiaohongshu (RedNote) |
| note_list[].type | string | null | An image note or a video note (full view) | Xiaohongshu (RedNote) |
| note_list[].published_at | string | null | The day it was published; the platform gives the day only, given as the start of that day in China time (full view) | Xiaohongshu (RedNote) |
| note_list[].cover_url | string | null | Address of the cover image (full view) | Xiaohongshu (RedNote) |
| note_list[].impressions | integer | null | Impressions (full view) | Xiaohongshu (RedNote) |
| note_list[].reads | integer | null | Reads (full view) | Xiaohongshu (RedNote) |
| note_list[].engagements | integer | null | Interactions (full view) | Xiaohongshu (RedNote) |
| note_list[].likes | integer | null | Likes (full view) | Xiaohongshu (RedNote) |
| note_list[].favorites | integer | null | Saves (full view) | Xiaohongshu (RedNote) |
| note_list[].impressions_vs_median | number | null | How far the note's impressions are above the creator's median impressions of the period: 1.5 is 150% more, -0.3 is 30% fewer, 0 is the median itself (full view) | Xiaohongshu (RedNote) |
| note_list[].reads_vs_median | number | null | How far the note's reads are above the creator's median reads of the period: 1.5 is 150% more, -0.3 is 30% fewer, 0 is the median itself (full view) | Xiaohongshu (RedNote) |
| note_list[].engagements_vs_median | number | null | How far the note's interactions are above the creator's median interactions of the period: 1.5 is 150% more, -0.3 is 30% fewer, 0 is the median itself (full view) | Xiaohongshu (RedNote) |
| note_list[].likes_vs_median | number | null | How far the note's likes are above the creator's median likes of the period: 1.5 is 150% more, -0.3 is 30% fewer, 0 is the median itself (full view) | Xiaohongshu (RedNote) |
| note_list[].favorites_vs_median | number | null | How far the note's saves are above the creator's median saves of the period: 1.5 is 150% more, -0.3 is 30% fewer, 0 is the median itself (full view) | 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 ↗