https://api.nexscope.ai/jm/getNicheReviewFromKeywordRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/jm/getNicheReviewFromKeyword |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | required | Keywords (required, please use the language of the corresponding site, such as English for the US site and German for the German site), the maximum length is 1000 characters |
countryCode | string | optional | Country code, optional values: `US` (United States), `JP` (Japan), `DE` (Germany) Example: US |
page | integer | optional | Page number (starting from 1) Example: 1 |
pageSize | integer | optional | Number of returns per page (10-100) Example: 50 |
sortField | string | optional | Sorting field, see sorting options below Example: unitsSoldT7 |
sortType | string | optional | Sorting method, optional values: `desc` (descending order), `asc` (ascending order) Example: desc |
productCountMin | integer | optional | Product quantity (current) minimum |
productCountMax | integer | optional | Product quantity (current) maximum |
brandCountMin | integer | optional | Minimum number of brands |
brandCountMax | integer | optional | Maximum number of brands |
avgPriceMin | number | optional | Average price (current) minimum |
avgPriceMax | number | optional | Average Price (Current) Maximum |
unitsSoldT7Min | integer | optional | Sales volume (7 days statistics) minimum value |
unitsSoldT7Max | integer | optional | Maximum sales volume (7-day statistics) |
searchVolumeT7Min | integer | optional | Search volume (7 days statistics) minimum value |
searchVolumeT7Max | integer | optional | Maximum search volume (7-day statistics) |
clickCountT7Min | integer | optional | Click volume (7 days statistics) minimum value |
clickCountT7Max | integer | optional | Maximum number of clicks (7-day statistics) |
clickConversionRateT7Min | number | optional | Minimum click conversion rate (7-day statistics), the value range is 0-1, representing 0%-100% |
clickConversionRateT7Max | number | optional | The maximum value of click conversion rate (7-day statistics), the value range is 0-1, representing 0%-100% |
top5BrandsClickShareMin | number | optional | The minimum share of clicks in the market segment occupied by the top 5 brands. The value range is 0-1, representing 0%-100%. |
top5BrandsClickShareMax | number | optional | The maximum share of clicks in the market segment occupied by the top 5 brands. The value range is 0-1, representing 0%-100%. |
top5ProductsClickShareMin | number | optional | The (current) minimum click share of the top 5 products, the value range is 0-1, representing 0%-100% |
top5ProductsClickShareMax | number | optional | The (current) maximum click share of the top 5 products, the value range is 0-1, representing 0%-100% |
sponsoredProductsPercentageMin | number | optional | The minimum SP advertising proportion, the value range is 0-1, representing 0%-100% |
sponsoredProductsPercentageMax | number | optional | The maximum proportion of SP advertising, the value range is 0-1, representing 0%-100% |
avgBrandAgeMin | number | optional | Average brand age (current) minimum |
avgBrandAgeMax | number | optional | Average Brand Age (Current) Max |
avgBrandAgeQoqMin | number | optional | Average brand age (90 days statistics) minimum value |
avgBrandAgeQoqMax | number | optional | Average brand age (90 days statistics) maximum value |
avgBrandAgeYoyMin | number | optional | Average brand age (360 days statistics) minimum value |
avgBrandAgeYoyMax | number | optional | Maximum average brand age (360 days statistics) |
avgSellingPartnerAgeMin | number | optional | Minimum average sales partner age |
avgSellingPartnerAgeMax | number | optional | Maximum average age of sales partners |
avgSellingPartnerAgeQoqMin | number | optional | Average sales partner age (90 days statistics) minimum |
avgSellingPartnerAgeQoqMax | number | optional | Maximum average age of sales partners (90-day statistics) |
avgSellingPartnerAgeYoyMin | number | optional | Average sales partner age (360 days statistics) minimum value |
avgSellingPartnerAgeYoyMax | number | optional | Maximum average age of sales partners (360 days statistics) |
launchRateT180Min | number | optional | The minimum success rate of product release (180-day statistics), the value range is 0-1, representing 0%-100% |
launchRateT180Max | number | optional | The maximum success rate of product release (180-day statistics), the value range is 0-1, representing 0%-100% |
newProductRateT180 | number | optional | The minimum value of the proportion of new products (180-day statistics), the value range is 0-1, representing 0%-100% |
returnRateT360Min | number | optional | The minimum return rate (360 days statistics), the value range is 0-1, representing 0%-100% |
returnRateT360Max | number | optional | The maximum return rate (360 days statistics), the value range is 0-1, representing 0%-100% |
cpcMediumMin | number | optional | CPC (current) minimum |
cpcMediumMax | number | optional | CPC (current) maximum |
Code example
{
"countryCode": "US",
"keyword": "yoga mat",
"pageSize": 20,
"sortField": "unitsSoldT7",
"sortType": "desc"
}Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
data | any | required | Data value used by this API operation. |
msg | string | null | required | Msg value used by this API operation. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.columns | any | optional | Columns value used by this API operation. |
data.costTime | any | optional | Cost time value used by this API operation. |
data.costToken | any | optional | Cost token value used by this API operation. |
data.data | any | optional | Data value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.keyword | any | optional | Keyword value used by this API operation. |
data.nicheId | any | optional | Niche id value used by this API operation. |
data.nicheName | any | optional | Niche name value used by this API operation. |
data.page | any | optional | Page value used by this API operation. |
data.pageItemCount | any | optional | Page item count value used by this API operation. |
data.pageSize | any | optional | Page size value used by this API operation. |
data.percentOfMentions | any | optional | Percent of mentions value used by this API operation. |
data.reviewExample | any | optional | Review example value used by this API operation. |
data.reviewType | any | optional | Review type value used by this API operation. |
data.sourceTool | any | optional | Source tool value used by this API operation. |
data.sourceType | any | optional | Source type value used by this API operation. |
data.title | any | optional | Title value used by this API operation. |
data.topic | any | optional | Topic value used by this API operation. |
data.total | any | optional | Total value used by this API operation. |
data.totalPage | any | optional | Total page value used by this API operation. |
data.type | any | optional | Type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | array | optional | Rendered columns Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | null | optional | Columns value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | null | optional | Cost time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | integer | optional | Consume token Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | null | optional | Cost token value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data | array | optional | List of market segment comments (see data item fields below for details) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data | null | optional | Data value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | null | optional | Data snapshot month value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keyword | string | optional | keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keyword | null | optional | Keyword value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nicheId | string | optional | Segment ID Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nicheId | null | optional | Niche id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nicheName | string | optional | Market segment name Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nicheName | null | optional | Niche name value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.page | null | optional | Page value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | null | optional | Page item count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | null | optional | Page size value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.percentOfMentions | number | optional | Proportion (the value range is 0-1, representing 0%-100%) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.percentOfMentions | null | optional | Percent of mentions value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.reviewExample | string | optional | Comment sample Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.reviewExample | null | optional | Review example value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.reviewType | string | optional | Comment type (value range is [positive comment], [negative comment]) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.reviewType | null | optional | Review type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | null | optional | Source tool value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | null | optional | Source type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.title | string | optional | Title Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.title | null | optional | Title value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.topic | string | optional | Comment topic Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.topic | null | optional | Topic value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.total | integer | optional | total Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.total | null | optional | Total value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | null | optional | Total page value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.type | string | optional | Rendering style Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.type | null | optional | Type value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.