DataNavoAPI / APIS / REDNOTE

Xiaohongshu PGY related keywords

Xiaohongshu PGY related keywords: inspect inputs, related keyword fields, pagination and limits, then run a local simulated request.

LOCAL SIMULATIONAll displayed records are fictional fixtures. Live APIs, payments and external email are disabled.中文版 ↗
01

What this capability does

Xiaohongshu PGY related keywords uses /v1/xiaohongshu/pgy/keywords/related; GET returns data.items with related keyword objects.

This is a local simulation. Program-generated samples are not live platform data and do not establish provider availability.

  • Capability: xiaohongshu.pgy.keywords.related
  • Pagination: no cursor pagination; do not repeatedly request another page.
02

Input contract

Inspect meanings, examples and conditional rules for the selected method. view and fields control the response without changing the TEST unit price.

  • Only send fields defined for this method; unknown fields are rejected before execution.
MethodFieldTypeRequirementMeaningEnum or boundExample
GETkeywordstringRequiredOne keyword—"面膜"
GETviewstringOptional / conditionalHow much of each item: compact (the most used fields, long text cut short), standard, or full (adds `ext`).["compact","standard","full"]—
GETfieldsarrayOptional / conditionalReturn only these fields of each item, by path (`author.name`).maxItems: 64—
03

Try it locally

Use demo to inspect the fields, then explicitly select simulated with a customer test key to exercise settlement. Never put a customer key in a URL.

json
{
  "capability": "xiaohongshu.pgy.keywords.related",
  "method": "GET",
  "params": {
    "keyword": "面膜"
  }
}
04

Output fields and interpretation

The keyword_related object permits missing or null values; do not replace missing measurements with zero. This table shows the main structure; the object reference covers nested fields.

FieldTypeMeaningSource scope
keywordstring | nullThe related keywordXiaohongshu (RedNote)
related_tostring | nullThe keyword it is related to: the one asked aboutXiaohongshu (RedNote)
relationstring | nullHow it is related: query (searched together with the keyword asked about), posts (appears together with it in content), prior (searched before it), after (searched after it), suggestion (what the platform suggests as the keyword is typed into its search box)Xiaohongshu (RedNote)
rankinteger | nullPosition by relevance among the keywords of the same relation, from 1Xiaohongshu (RedNote)
relevancenumber | nullHow closely it is related to the keyword asked about, 0 to 1Xiaohongshu (RedNote)
search_indexinteger | nullSearch index of the related keyword: the platform's index, not a count of searches; null where the platform gives no figure for the wordXiaohongshu (RedNote)
composite_indexinteger | nullComposite index of the related keyword: the platform's index of how much attention content about it drew, not a countXiaohongshu (RedNote)
approximatearray | nullWhich numbers of this item are approximate or lower bounds; absent when all are exactXiaohongshu (RedNote)
approximate[].fieldstring | nullPath of the field, such as metrics.viewsXiaohongshu (RedNote)
approximate[].kindstring | nullApproximate, or a lower boundXiaohongshu (RedNote)
extobject—Xiaohongshu (RedNote)
ext.notesinteger | nullNotes about the related keyword; null where the platform gives no figure for the word (full view)Xiaohongshu (RedNote)
ext.viewsinteger | nullReads of those notes in all; null where the platform gives no figure for the word (full view)Xiaohongshu (RedNote)
05

Unavailable fields

These published contract notes describe the capability boundary; fixtures do not establish live availability.

FieldReason
relevanceplatform
composite_indexplatform
06

Limits and checks

A successful request does not establish full coverage. Preserve the request ID, observation time, parameters and cursor, and inspect the returned items before analysis.

Local simulation uses TEST credits only. Real provider calls, real payments and external email are disabled. Historical reference-site prices are not DataNavoAPI prices.

  • Verify media URLs, counts and optional fields individually.
TRY THE CONTRACT

Clear inputs. Inspectable output.

Each click runs a local fixture. Advanced JSON inputs are checked against the selected method. Editing does not execute a request.

Copying does not execute. CLI quote is read-only and needs a local customer TEST key. Configure MCP in demo mode first. GET and POST batches both return only fictional local fixtures.

Download contract example (no execution) ↗

For TEST budgets, Key scopes or failure scenarios, open the account console. Customer sandbox ↗