# Xiaohongshu (RED) PGY Blogger Note Rates API

> Returns overall note performance metrics from a creator's data overview on Pugongying. Supports filtering by date range, note format, and advertising traffic.

Source: https://www.sandbase.ai/model/xiaohongshu/pgy/blogger-notes-rate
API reference: https://www.sandbase.ai/model/xiaohongshu/pgy/blogger-notes-rate/docs

## Facts

- Provider: Xiaohongshu
- Type: Data API
- Endpoint: `POST https://api.sandbase.ai/v1/api/xiaohongshu/pgy/blogger-notes-rate`
- Price: $0.03 per call
- Capabilities: api, xiaohongshu
- Billing: pay per use from one SandBase balance; no provider account or subscription needed

## Call it

`POST https://api.sandbase.ai/v1/api/xiaohongshu/pgy/blogger-notes-rate` with `Authorization: Bearer $SANDBASE_API_KEY` and the parameters as a JSON body.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `user_id` | string | yes |  |
| `advertise_switch` | integer | no | 0, 1 |
| `date_type` | integer | no |  |
| `note_type` | integer | no | 1, 2, 3 |

## FAQ

### How do I use the Xiaohongshu (RED) PGY Blogger Note Rates API?

Send a POST request to https://api.sandbase.ai/v1/api/xiaohongshu/pgy/blogger-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 (RED) PGY Blogger Note Rates 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 (RED) PGY Blogger Note Rates API accept?

Required: user_id (string). Optional: advertise_switch (one of 0, 1), date_type (integer) and note_type (one of 1, 2, 3). The Parameters table and the Playground on this page list every field.

### What does the Xiaohongshu (RED) PGY Blogger Note Rates API return?

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

### Do I need a Xiaohongshu developer account or API key?

No. Xiaohongshu (RED) PGY Blogger Note Rates 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.

## README

### Xiaohongshu (RED) PGY Blogger Note Rates API

Retrieve aggregated note performance statistics for a specific creator using `user_id`. Optional parameters filter metrics by date window, note format, and traffic source.

#### Use cases

- Evaluate creator engagement rates across image and video formats.
- Compare organic note performance against sponsored campaign traffic.
- Assess creator content delivery trends over 7, 30, or 90 days.

#### Request

```bash
curl -X POST "https://api.sandbase.ai/v1/api/xiaohongshu/pgy/blogger-notes-rate" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"user_id": "60b137080000000001000301"}'
```

#### Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `user_id` | string | Yes | Blogger user ID |
| `date_type` | integer | No | Date range (~1=7d, 2=30d, 3=90d) |
| `note_type` | integer | No | Note type, 1=image, 2=video, 3=all (default) |
| `advertise_switch` | integer | No | Traffic type, 1=all (incl. ads), 0=organic only |

#### Notes

- Use `date_type` to set the analysis window: 1 for 7 days, 2 for 30 days, or 3 for 90 days.
- `note_type` filters by format: 1 for image, 2 for video, or 3 for all notes.
- `advertise_switch` controls whether traffic includes advertising (1) or organic views only (0).

#### Related APIs

- [Xiaohongshu (RED) Blogger Core Data](/model/xiaohongshu/pgy/blogger-core-data): Returns Pugongying core performance metrics and daily trend data for a specified Xiaohongshu blogger, filterable by date range, note type, and traffic source.
- [Xiaohongshu (RED) PGY Blogger Data Summary](/model/xiaohongshu/pgy/blogger-data-summary): Returns an account-level data summary for a Xiaohongshu blogger on the Pugongying (PGY) platform based on the specified blogger user ID.
- [Xiaohongshu (RED) PGY Blogger Details](/model/xiaohongshu/pgy/blogger-detail): Retrieves detailed profile information for a specific Xiaohongshu blogger on the PGY platform using their user ID.