Xiaohongshu Pugongying Note Performance Metrics

https://api.sandbase.ai/v1/api/xiaohongshu/pgy-v2/data-v3-notes-rate

Get Xiaohongshu Pugongying aggregate note performance metrics for a creator with business, note-type, date-range, and advertisement filters. Use it to compare content performance across selected scopes.

Price
$0.03USD / call
Method
POST
Response
JSON
Parameters
1 required · 4 optional
Production route

Try the model

Playground

Open playground
Input
KOL's user ID.
Business type. Allowed values: DAILY_NOTE, COOPERATE_NOTE.
Type of note. Allowed values: PHOTO_TEXT_AND_VIDEO, PHOTO_TEXT, VIDEO.
Time range for data. Allowed values: DAY_30, DAY_90.
Advertisement filter. Allowed values: ALL, ORGANIC_ONLY.
OutputReady

Your output will appear here

Complete the inputs, then click Run.

Model card

Specifications

Pricing

Base price
$0.03 / run

Request & response

Method
POST
Request body
application/json
Response
application/json
Execution
sync

Parameters

userId
string · required
business
string (DAILY_NOTE, COOPERATE_NOTE) · optional
noteType
string (PHOTO_TEXT_AND_VIDEO, PHOTO_TEXT, VIDEO) · optional
dateType
string (DAY_30, DAY_90) · optional
advertiseSwitch
string (ALL, ORGANIC_ONLY) · optional

Access

Provider
Xiaohongshu
API
Platform API
Base URL
https://api.sandbase.ai
Endpoint
/v1/api/xiaohongshu/pgy-v2/data-v3-notes-rate
Authentication
Bearer API key

API README

Xiaohongshu Pugongying Note Performance Metrics API

Get Xiaohongshu Pugongying aggregate note performance metrics for a creator with business, note-type, date-range, and advertisement filters. Use it to compare content performance across selected scopes.

The response is the platform's original data structure.

Request

curl -X POST "https://api.sandbase.ai/v1/run" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "xiaohongshu/pgy-v2/data-v3-notes-rate", "userId": "5a73c5fa4eacab4c4ccc9778"}'

Parameters

NameTypeRequiredDescription
userIdstringYesKOL's user ID.
businessstringNoBusiness type.
noteTypestringNoType of note.
dateTypestringNoTime range for data.
advertiseSwitchstringNoAdvertisement filter.

Pricing

Flat price per call. Failed calls and empty results are not charged.

Start building

Send your first request

Platform API endpoint with unified authentication and usage tracking.

Production API
Platform API endpoint
https://api.sandbase.ai/v1/api/xiaohongshu/pgy-v2/data-v3-notes-rate
Authorization header
Authorization: Bearer $SANDBASE_API_KEY
# The quoted heredoc keeps Unicode and shell metacharacters unchanged.
result=$(curl --fail-with-body --silent \
  -X POST "https://api.sandbase.ai/v1/api/xiaohongshu/pgy-v2/data-v3-notes-rate" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'SANDBASE_JSON'
{
  "userId": "5a73c5fa4eacab4c4ccc9778",
  "business": "DAILY_NOTE",
  "dateType": "DAY_30",
  "noteType": "PHOTO_TEXT_AND_VIDEO",
  "advertiseSwitch": "ALL"
}
SANDBASE_JSON
)
printf '%s\n' "$result"

Explore more

Related APIs

All APIs
APIPriceResponseReleased
Xiaohongshu$0.03 per callJSONOct 29, 2026
Xiaohongshu$0.03 per callJSONOct 29, 2026
Xiaohongshu$0.10 per callJSONOct 29, 2026
Xiaohongshu$0.03 per callJSONOct 29, 2026
Xiaohongshu$0.03 per callJSONOct 29, 2026
Xiaohongshu$0.03 per callJSONOct 29, 2026

Questions

FAQ

How do I use the Xiaohongshu Pugongying Note Performance Metrics API?

Send a POST request to https://api.sandbase.ai/v1/api/xiaohongshu/pgy-v2/data-v3-notes-rate with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.

How much does the Xiaohongshu Pugongying Note Performance Metrics API cost?

$0.03 per call, billed from your SandBase balance. You are only charged for calls you make; there is no subscription.

What parameters does the Xiaohongshu Pugongying Note Performance Metrics API accept?

Required: userId (string). Optional: business (one of DAILY_NOTE, COOPERATE_NOTE), noteType (one of PHOTO_TEXT_AND_VIDEO, PHOTO_TEXT, VIDEO), dateType (one of DAY_30, DAY_90) and advertiseSwitch (one of ALL, ORGANIC_ONLY). The Parameters table and the Playground on this page list every field.

What does the Xiaohongshu Pugongying Note Performance Metrics API return?

A JSON response returned in the same HTTP request (synchronous).

Do I need a Xiaohongshu developer account or API key?

No. Xiaohongshu Pugongying Note Performance Metrics runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for Xiaohongshu API access separately.