POST
https://api.nexscope.ai/api/skill-api/v1/skills/amazon-reviews-list/runRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/api/skill-api/v1/skills/amazon-reviews-list/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
asin | string | required | Amazon product ASIN Example: B072MQ5BRX |
domainCode | string | optional | Amazon domain code, default com. Options: com, ca, co.uk, in, de, fr, it, es, co.jp, com.au, com.br, nl, se, com.mx, ae. Use com for the US site |
star1Num | integer | optional | Number of 1-star reviews, default 10, max 100 Example: 1 |
star2Num | integer | optional | Number of 2-star reviews, default 10, max 100 Example: 1 |
star3Num | integer | optional | Number of 3-star reviews, default 10, max 100 Example: 1 |
star4Num | integer | optional | Number of 4-star reviews, default 10, max 100 Example: 1 |
star5Num | integer | optional | Number of 5-star reviews, default 10, max 100 Example: 1 |
filterByKeyword | string | optional | Filter reviews by keyword, max length 1000 characters Example: phone case |
sortBy | string | optional | Review sort order: recent (most recent reviews) or helpful (most helpful reviews), default recent |
reviewerType | string | optional | Reviewer type: all_reviews (all reviews) or avp_only_reviews (verified purchases only), default all_reviews |
mediaType | string | optional | Media type: all_contents (all content) or media_reviews_only (reviews with media only), default all_contents |
formatType | string | optional | Format type: all_formats (all formats) or current_format (current format), default all_formats |
Request example
{
"domainCode": "com",
"star4Num": 1,
"star3Num": 1,
"star2Num": 1,
"star1Num": 1,
"star5Num": 1,
"asin": "B072MQ5BRX"
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | any | required | Data value used by this API operation. |
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
msg | string | null | required | Msg value used by this API operation. |
ts | string | required | Epoch milliseconds. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
traceId | string | null | required | Trace id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.total | integer | optional | Total review count Example: 1 |
data.data | array | optional | Review list (see review object below) Example: [] |
data.columns | array | optional | Rendered columns Example: [] |
data.costToken | integer | optional | Total token consumption Example: 1 |
data.type | string | optional | Render style Example: null |
data.columns[].reviewId | string | optional | Review ID Example: example-id |
data.columns[].asin | string | optional | Product ASIN Example: B072MQ5BRX |
data.columns[].title | string | optional | Review title Example: null |
data.columns[].text | string | optional | Review content Example: null |
data.columns[].rating | string | optional | Rating Example: null |
data.columns[].date | string | optional | Review date Example: 2026-01-01 |
data.columns[].userName | string | optional | Reviewer name Example: null |
data.columns[].verified | boolean | optional | Whether verified purchase Example: false |
data.columns[].vine | boolean | optional | Whether Vine Voice review Example: false |
data.columns[].numberOfHelpful | integer | optional | Helpful count Example: 1 |
data.columns[].imageUrlList | array | optional | Review image list Example: [] |
data.columns[].videoUrlList | array | optional | Review video list Example: [] |
data.columns[].domainCode | string | optional | Country code Example: null |
data.columns[].productTitle | string | optional | Product title Example: null |
data.columns[].productRating | string | optional | Product rating Example: null |
data.columns[].countRatings | integer | optional | Product rating count Example: 1 |
data.columns[].countReviews | integer | optional | Product review count Example: 1 |
data.columns[].variationId | string | optional | Variation ID Example: example-id |
data.columns[].variationList | array | optional | Variation list Example: [] |
data.columns[].profilePath | string | optional | Reviewer profile path Example: null |
data.columns[].currentPage | integer | optional | Current page number Example: 1 |
data.columns[].sortStrategy | string | optional | Sort strategy Example: null |
data.columns[].statusCode | integer | optional | Status code Example: 1 |
data.columns[].statusMessage | string | optional | Status message Example: null |
data.columns[].locale | object | optional | Locale information Example: {} |
data.columns[].reviewSummary | object | optional | Review summary data Example: {} |
data.columns[].filters | object | optional | Applied filter conditions Example: {} |
data.title | string | optional | Provider-specific response title. Example: null |
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"data": {
"total": 1,
"data": [],
"columns": [
{
"reviewId": "example-id",
"asin": "B072MQ5BRX",
"date": "2026-01-01",
"verified": false,
"vine": false,
"numberOfHelpful": 1,
"imageUrlList": [],
"videoUrlList": [],
"countRatings": 1,
"countReviews": 1,
"variationId": "example-id",
"variationList": [],
"currentPage": 1,
"statusCode": 1,
"locale": {},
"reviewSummary": {},
"filters": {}
}
],
"costToken": 1
},
"code": 0,
"msg": null,
"ts": "0",
"time": "2026-01-01 00:00:00",
"cost": "-1",
"traceId": null
}Responses
| Code | Description |
|---|---|
| 200 | HTTP request completed. Check JSON code; only 0 indicates business success or acceptance. |
| 400 | Request JSON or required API parameters are invalid. |
| 401 | API key is missing, invalid, or cannot be matched to a user. |
| 5xx | API execution or upstream service failed. |
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.