{
  "openapi": "3.0.0",
  "info": {
    "title": "Xiaohongshu Creator Marketplace (Pugongying) Note Performance Rates API (V1)",
    "version": "1.0.0",
    "description": "Get Xiaohongshu Creator Marketplace (Pugongying) note Performance Rates data, including core metrics, trend signals, and performance indicators, for content efficiency analysis, creator benchmarking, and campaign planning."
  },
  "paths": {
    "/api/xiaohongshu-pgy/get-kol-note-rate/v1": {
      "get": {
        "tags": [
          "Xiaohongshu Creator Marketplace (Pugongying)"
        ],
        "summary": "Note Performance Rates",
        "description": "Get Xiaohongshu Creator Marketplace (Pugongying) note Performance Rates data, including core metrics, trend signals, and performance indicators, for content efficiency analysis, creator benchmarking, and campaign planning.",
        "operationId": "getKolNoteRateV1",
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "description": "User authentication token.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "kolId",
            "in": "query",
            "description": "KOL ID.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "dateType",
            "in": "query",
            "description": "Date type.\n\nAvailable Values:\n- `_1`: Last 30 days\n- `_2`: Last 90 days",
            "required": false,
            "schema": {
              "type": "string",
              "default": "_1",
              "description": "Note rate date range type",
              "enum": [
                "_1",
                "_2"
              ]
            }
          },
          {
            "name": "noteType",
            "in": "query",
            "description": "Note type.\n\nAvailable Values:\n- `_1`: Photo and Text\n- `_2`: Video\n- `_3`: Photo and Video",
            "required": false,
            "schema": {
              "type": "string",
              "default": "_3",
              "description": "Note rate note type filter",
              "enum": [
                "_1",
                "_2",
                "_3"
              ]
            }
          },
          {
            "name": "adSwitch",
            "in": "query",
            "description": "Ad filter.\n\nAvailable Values:\n- `_1`: Full traffic (All notes)\n- `_0`: Natural traffic (Organic notes)",
            "required": false,
            "schema": {
              "type": "string",
              "default": "_1",
              "description": "Note rate advertisement filter",
              "enum": [
                "_1",
                "_0"
              ]
            }
          },
          {
            "name": "business",
            "in": "query",
            "description": "Business type.\n\nAvailable Values:\n- `_0`: Normal notes\n- `_1`: Cooperation notes",
            "required": false,
            "schema": {
              "type": "string",
              "default": "_0",
              "description": "Note rate business type",
              "enum": [
                "_0",
                "_1"
              ]
            }
          },
          {
            "name": "acceptCache",
            "in": "query",
            "description": "Enable cache.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default response",
            "content": {
              "application/json": {
                "example": {
                  "code": 0,
                  "data": {
                    "noteNumber": 0,
                    "videoNoteNumber": 0,
                    "hundredLikePercent": "0.0",
                    "thousandLikePercent": "0.0",
                    "noteType": [],
                    "tradeNames": null,
                    "impMedian": 0,
                    "impMedianBeyondRate": "0.0",
                    "readMedian": 0,
                    "readMedianBeyondRate": "0.0",
                    "interactionMedian": 0,
                    "interactionRate": "0.0",
                    "interactionBeyondRate": "0.0",
                    "likeMedian": 0,
                    "collectMedian": 0,
                    "commentMedian": 0,
                    "shareMedian": 0,
                    "videoFullViewRate": "0.0",
                    "videoFullViewBeyondRate": "0.0",
                    "picture3sViewRate": "0.0",
                    "notes": null,
                    "pagePercentVo": null,
                    "longTermCommonNoteVo": {
                      "startPublishTime": "2025-07-12",
                      "endPublishTime": "2025-09-10",
                      "noteNumber": 0,
                      "recentReadNum": null,
                      "recentReadBeyondRate": null,
                      "longTermReadNum": null,
                      "longTermReadBeyondRate": null,
                      "recentSearchPagePercent": null,
                      "recentFindPagePercent": null,
                      "recentKolHomePagePercent": null,
                      "recentFollowPagePercent": null,
                      "recentOtherPagePercent": null,
                      "longTermSearchPagePercent": null,
                      "longTermFindPagePercent": null,
                      "longTermKolHomePagePercent": null,
                      "longTermFollowPagePercent": null,
                      "longTermOtherPagePercent": null
                    },
                    "longTermCooperateNoteVo": {
                      "startPublishTime": "2025-07-12",
                      "endPublishTime": "2025-09-10",
                      "noteNumber": 0,
                      "recentReadNum": null,
                      "recentReadBeyondRate": null,
                      "longTermReadNum": null,
                      "longTermReadBeyondRate": null,
                      "recentSearchPagePercent": null,
                      "recentFindPagePercent": null,
                      "recentKolHomePagePercent": null,
                      "recentFollowPagePercent": null,
                      "recentOtherPagePercent": null,
                      "longTermSearchPagePercent": null,
                      "longTermFindPagePercent": null,
                      "longTermKolHomePagePercent": null,
                      "longTermFollowPagePercent": null,
                      "longTermOtherPagePercent": null
                    },
                    "mengagementNum": 0,
                    "mfollowCnt": 0,
                    "mEngagementNum": 0,
                    "mFollowCnt": 0
                  }
                }
              }
            }
          }
        },
        "deprecated": true,
        "x-order": "13002500"
      }
    }
  },
  "components": {}
}