xiaohongshu.pgy.bloggers.performance@v1
PGY Blogger MetricsPerformance Summary
Read aggregate note volume, median performance, rates, and content mix for the last 30 or 90 days.
/v1/xiaohongshu/pgy/bloggers/performanceChinese name: 小红书蒲公英博主表现概览 · 蒲公英博主指标 · 表现概览
读取近 30／90 日笔记量、中位表现、互动率、完播率、高赞笔记占比和内容占比。
Fielduser_idTypestringConstraints and defaultspattern: "^[a-f0-9]{24}$"RequirementRequiredFieldcontent_scopeTypestringConstraints and defaultsenum: "organic" | "commercial" · default: "organic"RequirementOptionalFieldnote_typeTypestringConstraints and defaultsenum: "all" | "image" | "video" · default: "all"RequirementOptionalFieldwindowTypestringConstraints and defaultsenum: "30d" | "90d" · default: "30d"RequirementOptionalFieldtrafficTypestringConstraints and defaultsenum: "all" | "organic" · default: "all"RequirementOptional{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"user_id": {
"type": "string",
"pattern": "^[a-f0-9]{24}$"
},
"content_scope": {
"default": "organic",
"type": "string",
"enum": [
"organic",
"commercial"
]
},
"note_type": {
"default": "all",
"type": "string",
"enum": [
"all",
"image",
"video"
]
},
"window": {
"default": "30d",
"type": "string",
"enum": [
"30d",
"90d"
]
},
"traffic": {
"default": "all",
"type": "string",
"enum": [
"all",
"organic"
]
}
},
"required": [
"user_id"
],
"additionalProperties": false
}{
"code": 200,
"request_id": "req_example_pgy_performance",
"message": "success",
"data": {
"creator_id": "5c668b3e0000000012021605",
"summary": {
"note_count": 18,
"median_impressions": 14057,
"median_reads": 1121,
"median_engagements": 154,
"engagement_rate": 8.75,
"completion_rate": 36.2,
"hundred_like_note_rate": 44.4,
"thousand_like_note_rate": 5.6,
"content_mix": [
{
"label": "图文",
"percent": 72.2
},
{
"label": "视频",
"percent": 27.8
}
]
}
},
"page": {
"next_cursor": null
},
"warnings": [],
"meta": {
"result_status": "complete",
"balance_after": "49.61",
"listing_id": "xiaohongshu.pgy.bloggers.performance",
"version": "v1",
"catalog_release_id": "catalog-production-2026-09-17.1",
"price_book_version": "pricebook-production-2026-09-17.1",
"charged_amount": "0.39",
"currency": "CNY"
}
}Complete and empty results are charged; partial results and failures are not.
The field summary is for scanning; the full JSON Schema is the stable output contract.
FieldcodeTypenumberConstraints and defaultsconst: 200RequirementRequiredFieldrequest_idTypestringConstraints and defaultsminLength: 1RequirementRequiredFieldmessageTypestringConstraints and defaultsconst: "success"RequirementRequiredFielddataTypeobjectConstraints and defaultsNo additional constraintsRequirementRequiredFieldpageTypeobjectConstraints and defaultsNo additional constraintsRequirementRequiredFieldwarningsTypearrayConstraints and defaultsNo additional constraintsRequirementRequiredFieldmetaTypeobjectConstraints and defaultsNo additional constraintsRequirementRequired{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"code": {
"type": "number",
"const": 200
},
"request_id": {
"type": "string",
"minLength": 1
},
"message": {
"type": "string",
"const": "success"
},
"data": {
"type": "object",
"properties": {
"creator_id": {
"type": "string",
"pattern": "^[a-f0-9]{24}$"
},
"summary": {
"anyOf": [
{
"type": "object",
"properties": {
"note_count": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"median_impressions": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"median_reads": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"median_engagements": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"engagement_rate": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"completion_rate": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"hundred_like_note_rate": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"thousand_like_note_rate": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"content_mix": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1
},
"percent": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"label",
"percent"
],
"additionalProperties": false
}
}
},
"required": [
"note_count",
"median_impressions",
"median_reads",
"median_engagements",
"engagement_rate",
"completion_rate",
"hundred_like_note_rate",
"thousand_like_note_rate",
"content_mix"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"creator_id",
"summary"
],
"additionalProperties": false
},
"page": {
"type": "object",
"properties": {
"next_cursor": {
"type": "null"
}
},
"required": [
"next_cursor"
],
"additionalProperties": false
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"meta": {
"type": "object",
"properties": {
"listing_id": {
"type": "string",
"const": "xiaohongshu.pgy.bloggers.performance"
},
"version": {
"type": "string",
"const": "v1"
},
"catalog_release_id": {
"type": "string",
"minLength": 1
},
"price_book_version": {
"type": "string",
"minLength": 1
},
"result_status": {
"type": "string",
"enum": [
"complete",
"empty"
]
},
"charged_amount": {
"type": "string"
},
"balance_after": {
"type": "string"
},
"currency": {
"type": "string",
"const": "CNY"
}
},
"required": [
"listing_id",
"version",
"catalog_release_id",
"price_book_version",
"result_status",
"charged_amount",
"balance_after",
"currency"
],
"additionalProperties": false
}
},
"required": [
"code",
"request_id",
"message",
"data",
"page",
"warnings",
"meta"
],
"additionalProperties": false
}curl -X POST https://api.dataxapi.com/v1/xiaohongshu/pgy/bloggers/performance \
-H "Authorization: Bearer $DATAXAPI_API_KEY" \
-H "Idempotency-Key: your-stable-intent-key" \
-H "Content-Type: application/json" \
-d '{"user_id":"5c668b3e0000000012021605","content_scope":"organic","note_type":"all","window":"30d","traffic":"all"}'[mcp_servers.dataxapi] url = "https://api.dataxapi.com/mcp" bearer_token_env_var = "DATAXAPI_API_KEY"
The same API key exposes only the precise tools in its scope. Keep the key in an environment variable, never in the config file. Reuse an explicit idempotency_key for safe retries.