---
title: "Xiaohongshu PGY creator metrics"
method: GET
path: "/v1/xiaohongshu/pgy/creators/metrics"
tags: ["xiaohongshu"]
---

# Xiaohongshu PGY creator metrics

`GET /v1/xiaohongshu/pgy/creators/metrics`

## Request

- Base URL: `https://api.dataxapi.com`
- URL: `https://api.dataxapi.com/v1/xiaohongshu/pgy/creators/metrics`
- Auth: HTTP bearer

Get how a Xiaohongshu creator's everyday or sponsored notes did over the last 30 or 90 days, by PGY creator ID: notes and video notes, median impressions, reads, interactions and follows, engagement and completion ratios, the share of notes past 100 and 1,000 likes, the standing among comparable creators, and the share of impressions and reads from the explore feed, search, the following feed and other entry points. The full view adds each note's impressions, reads and interactions and how far each is above the median, and long-term notes (published about half a year back): their recent and long-term reads and where those came from.

Price: $0.04 per call.

Preview: the returned object may change, announced beforehand.

## Query parameters

- `id` string, required
- `window` '30d' | '90d'
- `tab` 'everyday' | 'sponsored'
- `view` 'compact' | 'standard' | 'full'
- `fields` string[]

## Response `200`

OK

- object: The envelope every capability answers with.
  - `code` 'ok', required
  - `request_id` string, uuid, required
  - `data` object, required
    - `item` PgyCreatorMetrics, nullable, required: PGY creator metrics (preview: may change, announced beforehand).
      - `creator_id` string, nullable: PGY creator ID
      - `notes` integer, nullable: Notes in the period
      - `median_impressions` integer, nullable: Median impressions of a note
      - `median_reads` integer, nullable: Median reads of a note
      - `median_engagements` integer, nullable: Median interactions of a note
      - `median_likes` integer, nullable: Median likes of a note (standard view and up)
      - `median_favorites` integer, nullable: Median saves of a note (standard view and up)
      - `median_comments` integer, nullable: Median comments of a note (standard view and up)
      - `median_shares` integer, nullable: Median shares of a note (standard view and up)
      - `engagement_rate` number, nullable: Engagement rate, 0 to 1
      - `video_completion_rate` number, nullable: Completion rate of video notes, 0 to 1 (standard view and up)
      - `image_3s_read_rate` number, nullable: Share of image-note reads that last 3 seconds, 0 to 1 (standard view and up)
      - `hundred_like_share` number, nullable: Share of notes with 100 likes or more, 0 to 1 (standard view and up)
      - `thousand_like_share` number, nullable: Share of notes with 1,000 likes or more, 0 to 1 (standard view and up)
      - `impressions_percentile` number, nullable: Share of comparable creators whose median impressions it exceeds, 0 to 1 (standard view and up)
      - `reads_percentile` number, nullable: Share of comparable creators whose median reads it exceeds, 0 to 1 (standard view and up)
      - `engagements_percentile` number, nullable: Share of comparable creators whose median interactions it exceeds, 0 to 1 (standard view and up)
      - `video_notes` integer, nullable: Video notes in the period (counted in notes too) (standard view and up)
      - `video_completion_percentile` number, nullable: Share of comparable creators whose video completion rate it exceeds, 0 to 1 (standard view and up)
      - `median_follows` integer, nullable: Median follows a note brought (new followers gained from it) (standard view and up)
      - `traffic_sources` object, nullable: 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)
        - `impressions` object, nullable: Shares of the impressions (standard view and up)
          - `homefeed` number, nullable: Share of the impressions from the explore feed, 0 to 1 (standard view and up)
          - `search` number, nullable: Share of the impressions from search, 0 to 1 (standard view and up)
          - `follow` number, nullable: Share of the impressions from the following feed, 0 to 1 (standard view and up)
          - `detail` number, nullable: Share of the impressions from note detail pages, 0 to 1 (standard view and up)
          - `nearby` number, nullable: Share of the impressions from the nearby feed, 0 to 1 (standard view and up)
          - `other` number, nullable: Share of the impressions from anywhere else, 0 to 1 (standard view and up)
        - `reads` object, nullable: Shares of the reads (standard view and up)
          - `homefeed` number, nullable: Share of the reads from the explore feed, 0 to 1 (standard view and up)
          - `search` number, nullable: Share of the reads from search, 0 to 1 (standard view and up)
          - `follow` number, nullable: Share of the reads from the following feed, 0 to 1 (standard view and up)
          - `detail` number, nullable: Share of the reads from note detail pages, 0 to 1 (standard view and up)
          - `nearby` number, nullable: Share of the reads from the nearby feed, 0 to 1 (standard view and up)
          - `other` number, nullable: Share of the reads from anywhere else, 0 to 1 (standard view and up)
      - `long_term` object, nullable: 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)
        - `published_from` string, date-time, nullable: First publication day of these notes: a calendar day in China time (UTC+8), written as midnight UTC of its date (full view)
        - `published_to` string, date-time, nullable: Last publication day of these notes, written the same way (full view)
        - `notes` integer, nullable: Notes published in that span; with 0, everything below is null (full view)
        - `recent_reads` integer, nullable: 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)
        - `recent_reads_percentile` number, nullable: Share of comparable creators whose recent reads it exceeds, 0 to 1 (full view)
        - `long_term_reads` integer, nullable: Long-term reads: a figure of one note, as recent reads (full view)
        - `long_term_reads_percentile` number, nullable: Share of comparable creators whose long-term reads it exceeds, 0 to 1 (full view)
        - `recent_sources` object, nullable: Where the recent reads came from, shares adding up to 1 (full view)
          - `homefeed` number, nullable: Share of the recent reads from the explore feed, 0 to 1 (full view)
          - `search` number, nullable: Share of the recent reads from search, 0 to 1 (full view)
          - `profile` number, nullable: Share of the recent reads from the creator's profile page, 0 to 1 (full view)
          - `follow` number, nullable: Share of the recent reads from the following feed, 0 to 1 (full view)
          - `other` number, nullable: Share of the recent reads from anywhere else, 0 to 1 (full view)
        - `long_term_sources` object, nullable: Where the long-term reads came from, shares adding up to 1 (full view)
          - `homefeed` number, nullable: Share of the long-term reads from the explore feed, 0 to 1 (full view)
          - `search` number, nullable: Share of the long-term reads from search, 0 to 1 (full view)
          - `profile` number, nullable: Share of the long-term reads from the creator's profile page, 0 to 1 (full view)
          - `follow` number, nullable: Share of the long-term reads from the following feed, 0 to 1 (full view)
          - `other` number, nullable: Share of the long-term reads from anywhere else, 0 to 1 (full view)
      - `note_list` object[], nullable: 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)
        - `id` string, nullable: Note ID (full view)
        - `title` string, nullable: The note's title (full view)
        - `type` 'image' | 'video' | 'null', nullable: An image note or a video note (full view)
        - `published_at` string, date-time, nullable: The day it was published; the platform gives the day only, given as the start of that day in China time (full view)
        - `cover_url` string, uri, nullable: Address of the cover image (full view)
        - `impressions` integer, nullable: Impressions (full view)
        - `reads` integer, nullable: Reads (full view)
        - `engagements` integer, nullable: Interactions (full view)
        - `likes` integer, nullable: Likes (full view)
        - `favorites` integer, nullable: Saves (full view)
        - `impressions_vs_median` number, nullable: 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)
        - `reads_vs_median` number, nullable: 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)
        - `engagements_vs_median` number, nullable: 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)
        - `likes_vs_median` number, nullable: 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)
        - `favorites_vs_median` number, nullable: 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)
      - `approximate` object[], nullable: Which numbers of this item are approximate or lower bounds; absent when all are exact
        - `field` string, nullable: Path of the field, such as metrics.views
        - `kind` 'approximate' | 'lower_bound' | 'null', nullable: Approximate, or a lower bound
      - `ext` object: The platform's own fields (full view).
  - `page` Page: Present on capabilities that return lists. A page is asked for with `cursor`; each page is its own call and is charged on its own.
    - `next_cursor` string, nullable, required: Pass as `cursor` for the next page; null when there is none.
    - `cursor_expires_at` string, date-time, nullable, required
    - `has_more` boolean, required
    - `returned` integer, required
  - `warnings` Warning[], required
    - `code` 'items_dropped' | 'items_not_requested' | 'fields_unparsed' | 'text_truncated', required
    - `count` integer: items_dropped, items_not_requested: how many.
    - `item` integer: fields_unparsed, text_truncated: index of the item.
    - `fields` string[]
  - `meta` Meta, required
    - `capability` string, required
    - `result_status` 'complete' | 'partial' | 'empty', required
    - `fetched_at` string, date-time, required
    - `cached` boolean, required: From a shared snapshot.
    - `replayed` boolean, required: The saved result of an earlier call: `request_id` is that call's and nothing was added to the bill.
    - `unavailable` object, required: Fields this result could not carry, each with why.
    - `billing` object, required
      - `amount` string, required: US dollars, as a decimal string.
      - `currency` 'USD', required
      - `balance_after` string, nullable, required
      - `covers_next` unknown
      - `top_up_url` string, uri: With covers_next: where to top up.

## Other responses

- `4XX`: An error. Nothing was charged unless `charged` is null. - `invalid_params` (400, retry: after_fix, charged the endpoint's price where its data source billed the answer): A parameter is invalid - `request_not_served` (400, retry: after_fix): This combination of parameters cannot be served at present - `max_price_exceeded` (400, retry: after_fix): The most this call could cost is above the limit you set - `cursor_invalid` (400, retry: no): The cursor does not exist - `cursor_mismatch` (400, retry: after_fix): The cursor was issued for another endpoint or other parameters - `unauthorized` (401, retry: no): No credential was sent, or it is invalid, disabled or expired - `insufficient_balance` (402, retry: after_fix): The balance is too low - `key_budget_exceeded` (402, retry: after_fix): This key's spending limit does not cover the call - `run_budget_exceeded` (402, retry: no): This run's amount or call limit does not cover the call - `account_suspended` (403, retry: no): The account is suspended - `forbidden` (403, retry: no): This credential may not use that option - `key_scope_denied` (403, retry: no): This key may not call this endpoint - `not_found` (404, retry: no, charged the endpoint's price where its data source billed the answer): The object does not exist, is private or was deleted - `result_not_found` (404, retry: no): No result under this request ID - `run_not_found` (404, retry: no): No run under this run ID - `unknown_endpoint` (404, retry: no): There is no such endpoint - `call_in_progress` (409, retry: same_key): The call under this idempotency key is still running; ask again with the same key shortly - `idempotency_conflict` (409, retry: after_fix): This idempotency key was used for a different request - `cursor_expired` (410, retry: no): The cursor expired; start again from the first page - `result_expired` (410, retry: no): Results are kept for 24 hours; this one is gone - `run_expired` (410, retry: no): This run has expired and starts no more calls - `rate_limited` (429, retry: yes): Too many requests, or too many calls in progress - `cost_cap_exceeded` (429, retry: yes): This account's allowance for today is used up - `uncharged_cost_limit` (429, retry: yes): Too many of this account's calls today returned nothing and were not charged; endpoints of this kind can be called again tomorrow (UTC) - `settlement_unknown` (500, retry: same_key, may have been charged): Whether this call settled is not known; ask again with the same idempotency key, or look it up by request ID - `internal_error` (500, retry: yes): The service failed - `upstream_failed` (502, retry: yes): No result came back this time and nothing was charged; retry shortly - `cursor_unavailable` (502, retry: yes): This cursor is unavailable just now; retry later or start again from the first page - `upstream_busy` (503, retry: yes): Busy just now; retry shortly - `capability_paused` (503, retry: yes): This endpoint is paused - `overloaded` (503, retry: yes): The service is busy; retry shortly - `timeout` (504, retry: yes): The data did not arrive in time; retry with the same idempotency key
- `5XX`: An error. Nothing was charged unless `charged` is null. - `invalid_params` (400, retry: after_fix, charged the endpoint's price where its data source billed the answer): A parameter is invalid - `request_not_served` (400, retry: after_fix): This combination of parameters cannot be served at present - `max_price_exceeded` (400, retry: after_fix): The most this call could cost is above the limit you set - `cursor_invalid` (400, retry: no): The cursor does not exist - `cursor_mismatch` (400, retry: after_fix): The cursor was issued for another endpoint or other parameters - `unauthorized` (401, retry: no): No credential was sent, or it is invalid, disabled or expired - `insufficient_balance` (402, retry: after_fix): The balance is too low - `key_budget_exceeded` (402, retry: after_fix): This key's spending limit does not cover the call - `run_budget_exceeded` (402, retry: no): This run's amount or call limit does not cover the call - `account_suspended` (403, retry: no): The account is suspended - `forbidden` (403, retry: no): This credential may not use that option - `key_scope_denied` (403, retry: no): This key may not call this endpoint - `not_found` (404, retry: no, charged the endpoint's price where its data source billed the answer): The object does not exist, is private or was deleted - `result_not_found` (404, retry: no): No result under this request ID - `run_not_found` (404, retry: no): No run under this run ID - `unknown_endpoint` (404, retry: no): There is no such endpoint - `call_in_progress` (409, retry: same_key): The call under this idempotency key is still running; ask again with the same key shortly - `idempotency_conflict` (409, retry: after_fix): This idempotency key was used for a different request - `cursor_expired` (410, retry: no): The cursor expired; start again from the first page - `result_expired` (410, retry: no): Results are kept for 24 hours; this one is gone - `run_expired` (410, retry: no): This run has expired and starts no more calls - `rate_limited` (429, retry: yes): Too many requests, or too many calls in progress - `cost_cap_exceeded` (429, retry: yes): This account's allowance for today is used up - `uncharged_cost_limit` (429, retry: yes): Too many of this account's calls today returned nothing and were not charged; endpoints of this kind can be called again tomorrow (UTC) - `settlement_unknown` (500, retry: same_key, may have been charged): Whether this call settled is not known; ask again with the same idempotency key, or look it up by request ID - `internal_error` (500, retry: yes): The service failed - `upstream_failed` (502, retry: yes): No result came back this time and nothing was charged; retry shortly - `cursor_unavailable` (502, retry: yes): This cursor is unavailable just now; retry later or start again from the first page - `upstream_busy` (503, retry: yes): Busy just now; retry shortly - `capability_paused` (503, retry: yes): This endpoint is paused - `overloaded` (503, retry: yes): The service is busy; retry shortly - `timeout` (504, retry: yes): The data did not arrive in time; retry with the same idempotency key

---

[API](https://skmtc.dev/data-x-api/apis/openapi.md) - [All operations](https://skmtc.dev/data-x-api/apis/openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/data-x-api/apis/openapi/revisions/929c12db713d?raw)
