Skip to content
DataXAPI
Xiaohongshu

xiaohongshu.pgy.bloggers.coredata@v1

Xiaohongshu PGY creator core trend

PGY Blogger MetricsTrend

Read daily and period totals for the last 30 or 90 days of creator performance.

POST/v1/xiaohongshu/pgy/bloggers/core-data

Chinese name: 小红书蒲公英博主核心数据趋势 · 蒲公英博主指标 · 趋势
读取近 30／90 日表现的逐日趋势与区间汇总。

Use it when

  • Use it to analyze changes in exposure, reads, engagement, and cost over time.

Do not use it for

  • Do not use it for the current content mix and pricing summary.

Request parameters

Fielduser_idTypestringConstraints and defaultspattern: "^[a-f0-9]{24}$"RequirementRequired
Fieldcontent_scopeTypestringConstraints and defaultsenum: "organic" | "commercial" · default: "organic"RequirementOptional
Fieldnote_typeTypestringConstraints and defaultsenum: "all" | "image" | "video" · default: "all"RequirementOptional
FieldwindowTypestringConstraints and defaultsenum: "30d" | "90d" · default: "30d"RequirementOptional
FieldtrafficTypestringConstraints and defaultsenum: "all" | "organic" · default: "all"RequirementOptional
Full request JSON Schema
{
  "$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
}

Static response example

application/json
{
  "code": 200,
  "request_id": "req_example_pgy_blogger_core",
  "message": "success",
  "data": {
    "creator_id": "5c668b3e0000000012021605",
    "daily": [
      {
        "date": "2026-08-01",
        "impressions": 14057,
        "reads": 1121,
        "engagements": 154,
        "cpm": 19.2,
        "cpe": 3.1,
        "cpv": 2.2,
        "cpuv": 4.3,
        "offsite_users": 19
      }
    ],
    "summary": {
      "date": "2026-07-03~2026-08-01",
      "impressions": 14057,
      "reads": 1121,
      "engagements": 154,
      "cpm": 19.2,
      "cpe": 3.1,
      "cpv": 2.2,
      "cpuv": 4.3,
      "offsite_users": 19
    }
  },
  "page": {
    "next_cursor": null
  },
  "warnings": [],
  "meta": {
    "result_status": "complete",
    "balance_after": "49.61",
    "listing_id": "xiaohongshu.pgy.bloggers.coredata",
    "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"
  }
}

Unavailable while paused

Complete and empty results are charged; partial results and failures are not.

Response contract

The field summary is for scanning; the full JSON Schema is the stable output contract.

FieldcodeTypenumberConstraints and defaultsconst: 200RequirementRequired
Fieldrequest_idTypestringConstraints and defaultsNo additional constraintsRequirementRequired
FieldmessageTypestringConstraints and defaultsconst: "success"RequirementRequired
FielddataTypeobjectConstraints and defaultsNo additional constraintsRequirementRequired
FieldpageTypeobjectConstraints and defaultsNo additional constraintsRequirementRequired
FieldwarningsTypearrayConstraints and defaultsNo additional constraintsRequirementRequired
FieldmetaTypeobjectConstraints and defaultsNo additional constraintsRequirementRequired
Full response JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "const": 200
    },
    "request_id": {
      "type": "string"
    },
    "message": {
      "type": "string",
      "const": "success"
    },
    "data": {
      "type": "object",
      "properties": {
        "creator_id": {
          "type": "string"
        },
        "daily": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "date": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "impressions": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "reads": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "engagements": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "cpm": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "cpe": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "cpv": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "cpuv": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "offsite_users": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "date",
              "impressions",
              "reads",
              "engagements",
              "cpm",
              "cpe",
              "cpv",
              "cpuv",
              "offsite_users"
            ],
            "additionalProperties": false
          }
        },
        "summary": {
          "type": "object",
          "properties": {
            "date": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "impressions": {
              "anyOf": [
                {
                  "type": "number",
                  "minimum": 0
                },
                {
                  "type": "null"
                }
              ]
            },
            "reads": {
              "anyOf": [
                {
                  "type": "number",
                  "minimum": 0
                },
                {
                  "type": "null"
                }
              ]
            },
            "engagements": {
              "anyOf": [
                {
                  "type": "number",
                  "minimum": 0
                },
                {
                  "type": "null"
                }
              ]
            },
            "cpm": {
              "anyOf": [
                {
                  "type": "number",
                  "minimum": 0
                },
                {
                  "type": "null"
                }
              ]
            },
            "cpe": {
              "anyOf": [
                {
                  "type": "number",
                  "minimum": 0
                },
                {
                  "type": "null"
                }
              ]
            },
            "cpv": {
              "anyOf": [
                {
                  "type": "number",
                  "minimum": 0
                },
                {
                  "type": "null"
                }
              ]
            },
            "cpuv": {
              "anyOf": [
                {
                  "type": "number",
                  "minimum": 0
                },
                {
                  "type": "null"
                }
              ]
            },
            "offsite_users": {
              "anyOf": [
                {
                  "type": "number",
                  "minimum": 0
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "date",
            "impressions",
            "reads",
            "engagements",
            "cpm",
            "cpe",
            "cpv",
            "cpuv",
            "offsite_users"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "creator_id",
        "daily",
        "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.coredata"
        },
        "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
}

Known limitations

  • Only 30-day and 90-day windows are supported.
  • Metrics follow the current PGY methodology; missing values are not estimated.
  • Content scope, note type, and traffic filters materially change the result.

Integration example

REST (cURL)

curl -X POST https://api.dataxapi.com/v1/xiaohongshu/pgy/bloggers/core-data \
  -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"}'

Exact MCP Preview (Codex config)

[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.

View client compatibility →

Catalog release: catalog-production-2026-09-17.1 · PriceBook: pricebook-production-2026-09-17.1