Skip to content

Xiaohongshu Creator Marketplace (Pugongying) Note Performance Metrics API (V1)

GET
/api/xiaohongshu-pgy/api/solar/kol/dataV3/notesRate/v1
API health status
Healthy Available Limited Mostly unavailable No data
Loading health status...

Get Xiaohongshu Creator Marketplace (Pugongying) note performance metrics data, including core metrics, trend signals, and performance indicators, for content efficiency analysis, creator benchmarking, and campaign planning.

Parameters

NameInTypeRequiredDefaultDescription
tokenquerystringYes-User authentication token.
userIdquerystringYes-KOL's user ID.
businessquerystringNoDAILY_NOTEBusiness type.

Available Values:
- DAILY_NOTE: Daily notes
- COOPERATE_NOTE: Cooperative notes
noteTypequerystringNoPHOTO_TEXT_AND_VIDEOType of note.

Available Values:
- PHOTO_TEXT_AND_VIDEO: Photo and Video
- PHOTO_TEXT: Photo and Text
- VIDEO: Video only
dateTypequerystringNoDAY_30Time range for data.

Available Values:
- DAY_30: Last 30 days
- DAY_90: Last 90 days
advertiseSwitchquerystringNoALLAdvertisement filter.

Available Values:
- ALL: All notes
- ORGANIC_ONLY: Organic notes only

Code Samples

💡 Environment Note

Use https://api.justoneapi.com (prod-global) by default. Judge whether to switch environments by the full duration of real API calls; if you are in Mainland China and prod-global has a longer full response time, or prod-cn is faster in practice, switch the base URL in code to http://47.117.133.51:30015 (prod-cn).

bash
curl -X GET "https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV3/notesRate/v1?token=YOUR_API_KEY&userId=VALUE"
text
I want to use the "Note Performance Metrics (V1)" API from Just One API.
API Endpoint: https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV3/notesRate/v1
HTTP Method: GET
Authentication: Append "?token=YOUR_API_KEY" to the URL.
OpenAPI Definition: https://docs.justoneapi.com/openapi/xiaohongshu-creator-marketplace-pugongying/note-performance-metrics-v1-en.json

Parameters:
- token (query): User authentication token. (Required)
- userId (query): KOL's user ID. (Required)
- business (query): Business type.

Available Values:
- `DAILY_NOTE`: Daily notes
- `COOPERATE_NOTE`: Cooperative notes
- noteType (query): Type of note.

Available Values:
- `PHOTO_TEXT_AND_VIDEO`: Photo and Video
- `PHOTO_TEXT`: Photo and Text
- `VIDEO`: Video only
- dateType (query): Time range for data.

Available Values:
- `DAY_30`: Last 30 days
- `DAY_90`: Last 90 days
- advertiseSwitch (query): Advertisement filter.

Available Values:
- `ALL`: All notes
- `ORGANIC_ONLY`: Organic notes only

Return format: JSON

Response Handling & Error Codes:
1. Business results should be determined by the "code" field in the response body (code 0 means success).
2. Timeout Recommendation: Set request timeout to at least 60 seconds.
3. Business Code Reference:
   - 0: Success
   - 100: Invalid or Inactive Token
   - 301: Collection Failed. Please Retry.
   - 302: Rate Limit Exceeded
   - 303: Daily Quota Exceeded
   - 400: Invalid Parameters
   - 500: Internal Server Error
   - 600: Permission Denied
   - 601: Insufficient Balance

Please help me write a script in my preferred programming language to call this API and handle the response.
python
import requests

url = "https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV3/notesRate/v1?token=YOUR_API_KEY&userId=VALUE"
response = requests.get(url)
print(response.json())
js
const response = await fetch("https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV3/notesRate/v1?token=YOUR_API_KEY&userId=VALUE", {
  method: "GET"
});
const data = await response.json();
console.log(data);
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV3/notesRate/v1?token=YOUR_API_KEY&userId=VALUE"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}
go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	client := &http.Client{}
	url := "https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV3/notesRate/v1?token=YOUR_API_KEY&userId=VALUE"
	req, _ := http.NewRequest("GET", url, nil)
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}
php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.justoneapi.com/api/xiaohongshu-pgy/api/solar/kol/dataV3/notesRate/v1?token=YOUR_API_KEY&userId=VALUE");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Response Example

Loading the latest successful example...

OK