View raw JSON
{
"type": "object",
"required": [
"body"
],
"properties": {
"body": {
"type": "object",
"title": "ContentSquareReq",
"required": [
"biz_type"
],
"properties": {
"fans": {
"anyOf": [
{
"type": "object",
"title": "RangeFilter",
"properties": {
"max": {
"anyOf": [
{
"type": "integer",
"maximum": 9999999,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Max",
"description": "Maximum value, inclusive; omit for no upper limit."
},
"min": {
"anyOf": [
{
"type": "integer",
"maximum": 9999999,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Min",
"description": "Minimum value, inclusive."
}
},
"description": "Numeric range; at least one endpoint is required.",
"x-readme-ref-name": "crawlers__xiaohongshu__pgy__pgy_content_filters__RangeFilter",
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "Creator fan-count range; only for board 4."
},
"price": {
"anyOf": [
{
"type": "object",
"title": "PriceFilter",
"required": [
"kind",
"range"
],
"properties": {
"kind": {
"enum": [
1,
2
],
"type": "integer",
"title": "Kind",
"description": "Price metric: 1=image-text post, 2=video post."
},
"range": {
"type": "object",
"title": "RangeFilter",
"properties": {
"max": {
"anyOf": [
{
"type": "integer",
"maximum": 9999999,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Max",
"description": "Maximum value, inclusive; omit for no upper limit."
},
"min": {
"anyOf": [
{
"type": "integer",
"maximum": 9999999,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Min",
"description": "Minimum value, inclusive."
}
},
"description": "Quoted price range in CNY.",
"additionalProperties": false
}
},
"description": "On the website, image-text and video posts use separate price metrics; choose one first.",
"x-readme-ref-name": "PriceFilter",
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "Creator quoted price; only for board 4."
},
"theme": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Theme",
"examples": [
"开箱"
],
"description": "Theme name for boards 2, 4, 5, 7 and 8."
},
"biz_type": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer",
"title": "Biz Type",
"examples": [
1
],
"description": "Leaderboard: 1=Xiaohongshu hot, 2=product seeding, 3=e-commerce promotion, 4=PGY collaboration, 5=lead collection, 6=e-commerce hot, 7=direct seeding, 8=app promotion."
},
"category": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Category",
"examples": [
"内容类目#美妆"
],
"description": "Category for board 1, formatted as level-one#level-two, for example content#beauty."
},
"industry": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Industry",
"examples": [
"母婴"
],
"description": "Industry name for boards 2, 3, 4, 5, 6, 7 and 8; available values vary by board."
},
"order_by": {
"type": "string",
"title": "Order By",
"default": "",
"examples": [
"premium_imp_num"
],
"maxLength": 64,
"description": "Sort field; leave empty to use the board default."
},
"page_num": {
"type": "integer",
"title": "Page Num",
"default": 1,
"maximum": 100,
"minimum": 1,
"examples": [
1
],
"description": "Page number; each board contains exactly 100 entries."
},
"note_type": {
"anyOf": [
{
"enum": [
1,
2
],
"type": "integer"
},
{
"type": "null"
}
],
"title": "Note Type",
"examples": [
2
],
"description": "Content type: 1=image-text, 2=video."
},
"page_size": {
"type": "integer",
"title": "Page Size",
"default": 34,
"maximum": 34,
"minimum": 1,
"examples": [
34
],
"description": "Items per page, 1-34; the website uses 34."
},
"placement": {
"anyOf": [
{
"enum": [
1,
2,
3
],
"type": "integer"
},
{
"type": "null"
}
],
"title": "Placement",
"examples": [
1
],
"description": "Traffic placement for boards 2, 3, 5, 7 and 8: 1=discover, 2=search, 3=in-video feed."
},
"date_range": {
"enum": [
3,
7,
14,
30
],
"type": "integer",
"title": "Date Range",
"default": 7,
"examples": [
7
],
"description": "Statistics window in days: 3, 7, 14 or 30."
},
"author_type": {
"anyOf": [
{
"enum": [
1,
2
],
"type": "integer"
},
{
"type": "null"
}
],
"title": "Author Type",
"examples": [
1
],
"description": "For board 4: 1=PGY creator, 2=celebrity."
},
"search_word": {
"type": "string",
"title": "Search Word",
"default": "",
"examples": [
"面膜"
],
"maxLength": 100,
"description": "Keyword; leave empty for the full board. Separate multiple keywords with English commas."
},
"content_type": {
"anyOf": [
{
"enum": [
1,
2,
3,
5,
6,
11,
-1
],
"type": "integer"
},
{
"type": "null"
}
],
"title": "Content Type",
"examples": [
1
],
"description": "Content source: 1=creator collaboration, 2=celebrity collaboration, 3=employee, 5=buyer, 6=professional account, 11=owner, -1=user."
},
"sub_biz_type": {
"anyOf": [
{
"enum": [
1,
2,
3
],
"type": "integer"
},
{
"type": "null"
}
],
"title": "Sub Biz Type",
"examples": [
3
],
"description": "For board 8: 1=app download, 2=mini-program promotion, 3=app launch (default)."
},
"marketing_target": {
"anyOf": [
{
"enum": [
3,
8
],
"type": "integer"
},
{
"type": "null"
}
],
"title": "Marketing Target",
"examples": [
3
],
"description": "For board 3: 3=product promotion, 8=live-stream promotion."
}
},
"x-readme-ref-name": "ContentSquareReq",
"additionalProperties": false
},
"queryParams": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"additionalProperties": false
}
