PgyCreatorMetrics object

How a Xiaohongshu creator's notes perform on PGY over a period: medians, rates, standing among peers and where the traffic came from. 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
`creator_id`	string	compact	PGY creator ID.
`notes`	integer \| null	compact	Notes in the period.
`median_impressions`	integer \| null	compact	Median impressions of a note.
`median_reads`	integer \| null	compact	Median reads of a note.
`median_engagements`	integer \| null	compact	Median interactions of a note.
`median_likes`	integer \| null	standard	Median likes of a note.
`median_favorites`	integer \| null	standard	Median saves of a note.
`median_comments`	integer \| null	standard	Median comments of a note.
`median_shares`	integer \| null	standard	Median shares of a note.
`engagement_rate`	number \| null	compact	Interactions per read, 0 to 1.
`video_completion_rate`	number \| null	standard	Completion rate of video notes, 0 to 1.
`image_3s_read_rate`	number \| null	standard	Share of image-note reads that lasted 3 seconds, 0 to 1.
`hundred_like_share`	number \| null	standard	Share of notes with 100 likes or more, 0 to 1.
`thousand_like_share`	number \| null	standard	Share of notes with 1,000 likes or more, 0 to 1.
`impressions_percentile`	number \| null	standard	Share of comparable creators this one beats on median impressions, 0 to 1.
`reads_percentile`	number \| null	standard	Share of comparable creators this one beats on median reads, 0 to 1.
`engagements_percentile`	number \| null	standard	Share of comparable creators this one beats on median interactions, 0 to 1.
`video_notes`	integer \| null	standard	Video notes in the period (included in notes).
`video_completion_percentile`	number \| null	standard	Share of comparable creators this one beats on video completion rate, 0 to 1.
`median_follows`	integer \| null	standard	Median new followers a note brought.
`traffic_sources`	PgyTrafficSources \| null	standard	Where the notes got their impressions and reads; each set adds up to 1.
`long_term`	PgyLongTerm \| null	full	Long-term performance of notes from about half a year back: recent and long-term reads, standing and sources.
`note_list`	PgyNoteFigures[] \| null	full	The period's notes one by one, oldest first, 15 at most; null when there is none.
`ext`	object	full	Platform-specific extras. Only returned with view=full. · only with view=full

PgyTrafficSources

Field	Type	Description
`impressions`	PgySourceShares \| null	Where the impressions came from.
`reads`	PgySourceShares \| null	Where the reads came from.

PgyLongTerm

Field	Type	Description
`published_from`	string \| null	First publication day of the notes counted: a calendar day in China time (UTC+8), written as 00:00 UTC of that date.
`published_to`	string \| null	Last publication day of the notes counted, written the same way.
`notes`	integer \| null	Notes published in that span; when 0 the figures below are null.
`recent_reads`	integer \| null	Reads of a typical note soon after publication, the platform's representative figure.
`recent_reads_percentile`	number \| null	Share of comparable creators this one beats on recent reads, 0 to 1.
`long_term_reads`	integer \| null	Reads of a typical note in the long term, after the recent part.
`long_term_reads_percentile`	number \| null	Share of comparable creators this one beats on long-term reads, 0 to 1.
`recent_sources`	PgyReadSources \| null	Where the recent reads came from.
`long_term_sources`	PgyReadSources \| null	Where the long-term reads came from.

PgyNoteFigures

Field	Type	Description
`id`	string	Note ID.
`title`	string \| null	The note's title.
`type`	string \| null	Image note or video note.
`published_at`	string \| null	Publication day, as 00:00 China time (the platform gives the day only).
`cover_url`	string \| null	Cover image.
`impressions`	integer \| null	Impressions.
`reads`	integer \| null	Reads.
`engagements`	integer \| null	Interactions.
`likes`	integer \| null	Likes.
`favorites`	integer \| null	Saves.
`impressions_vs_median`	number \| null	The note's impressions against the creator's median for the period: 0.5 is 50% above, -0.3 is 30% below.
`reads_vs_median`	number \| null	The note's reads against the creator's median for the period: 0.5 is 50% above, -0.3 is 30% below.
`engagements_vs_median`	number \| null	The note's interactions against the creator's median for the period: 0.5 is 50% above, -0.3 is 30% below.
`likes_vs_median`	number \| null	The note's likes against the creator's median for the period: 0.5 is 50% above, -0.3 is 30% below.
`favorites_vs_median`	number \| null	The note's saves against the creator's median for the period: 0.5 is 50% above, -0.3 is 30% below.

Example · xiaohongshu

{
  "creator_id": null,
  "notes": null,
  "median_impressions": null,
  "median_reads": null,
  "median_engagements": null,
  "median_likes": null,
  "median_favorites": null,
  "median_comments": null,
  "median_shares": null,
  "engagement_rate": null,
  "video_completion_rate": null,
  "image_3s_read_rate": null,
  "hundred_like_share": null,
  "thousand_like_share": null,
  "impressions_percentile": null,
  "reads_percentile": null,
  "engagements_percentile": null,
  "video_notes": null,
  "video_completion_percentile": null,
  "median_follows": null,
  "traffic_sources": {
    "impressions": {
      "homefeed": null,
      "search": null,
      "follow": null,
      "detail": null,
      "nearby": null,
      "other": null
    },
    "reads": {
      "homefeed": null,
      "search": null,
      "follow": null,
      "detail": null,
      "nearby": null,
      "other": null
    }
  },
  "long_term": {
    "published_from": null,
    "published_to": null,
    "notes": null,
    "recent_reads": null,
    "recent_reads_percentile": null,
    "long_term_reads": null,
    "long_term_reads_percentile": null,
    "recent_sources": {
      "homefeed": null,
      "search": null,
      "profile": null,
      "follow": null,
      "other": null
    },
    "long_term_sources": {
      "homefeed": null,
      "search": null,
      "profile": null,
      "follow": null,
      "other": null
    }
  },
  "note_list": [
    {
      "id": null,
      "title": null,
      "type": null,
      "published_at": null,
      "cover_url": null,
      "impressions": null,
      "reads": null,
      "engagements": null,
      "likes": null,
      "favorites": null,
      "impressions_vs_median": null,
      "reads_vs_median": null,
      "engagements_vs_median": null,
      "likes_vs_median": null,
      "favorites_vs_median": null
    }
  ]
}

Endpoints that return a PgyCreatorMetrics

Xiaohongshu PGY creator note metricsxiaohongshu.pgy.creators.metricsPgyCreatorMetrics$0.04/call

PgyTrafficSources

PgyLongTerm

PgyNoteFigures

Endpoints that return a PgyCreatorMetrics

Connect once, then just ask.