POST
https://api.nexscope.ai/api/skill-api/v1/skills/amazon-keyword-overview/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-keyword-overview/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | required | Keyword, translate to the corresponding country's language whenever possible. Max length: 1000 characters Example: phone case |
country | string | optional | Country site, default US. Options (13 total): US, UK, DE, CA, JP, FR, ES, IT, MX, AU, AE, BR, SA |
last7d | boolean | optional | Whether to get last 7 days data, default true. When false, use startDate/endDate range Example: true |
startDate | string | optional | Start date yyyy-MM-dd (effective when last7d=false) Example: 2026-01-01 |
endDate | string | optional | End date yyyy-MM-dd (paired with startDate) Example: 2026-01-01 |
Request example
{
"country": "US",
"keyword": "phone case",
"last7d": true
}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 data count. Note: this endpoint typically returns only a single record, total is usually 1 Example: 1 |
data.data | array | optional | Return data (see data fields below) Example: [] |
data.costTime | integer | optional | Latency (ms) Example: 1 |
data.costToken | integer | optional | Tokens consumed Example: 1 |
data.columns | array | optional | Render columns Example: [] |
data.type | string | optional | Render style Example: null |
data.title | string | optional | Title Example: null |
data.data[].keyword | string | optional | Keyword. The keyword text of the search query Example: phone case |
data.data[].keywordPopularityRank | integer | optional | Keyword popularity rank. This keyword's monthly search volume ranking among all Amazon keywords; lower values indicate higher search volume Example: 1 |
data.data[].estimatedWeeklySearchVolume | integer | optional | Estimated weekly search volume. Estimated weekly search count for this keyword on Amazon, reflecting its search popularity Example: 1 |
data.data[].supplyDemandRatio | number | optional | Supply-demand ratio. Ratio of supply to demand, formula: search result product count / monthly search volume; lower values indicate less competition and greater opportunity Example: 1 |
data.data[].totalSearchResultProductCount | integer | optional | Total search result product count. Total number of products displayed for this keyword (including natural search, ad placements, recommendation placements, etc.) Example: 1 |
data.data[].naturalSearchProductCount | integer | optional | Natural search product count. Number of products displayed in natural search results for this keyword (excluding ad placements) Example: 1 |
data.data[].sponsoredProductsCount | integer | optional | SP ad product count. Number of products running Sponsored Products ads for this keyword Example: 1 |
data.data[].brandAdProductCount | integer | optional | Brand ad product count. Number of products running brand ads for this keyword Example: 1 |
data.data[].videoAdProductCount | integer | optional | Video ad product count. Number of products running video ads for this keyword Example: 1 |
data.data[].paidAdvertisingProductCount | integer | optional | Total PPC ad product count. Total number of products running any PPC paid ads for this keyword (including SP, brand ads, video ads, etc.) Example: 1 |
data.data[].amazonChoiceProductCount | integer | optional | Amazon's Choice product count. Number of products with the Amazon's Choice badge for this keyword Example: 1 |
data.data[].topRatedProductCount | integer | optional | Top Rated recommended product count. Number of products appearing in the Top Rated (high rating) recommendation placement for this keyword Example: 1 |
data.data[].searchRecommendationProductCount | integer | optional | Search recommendation product count. Number of products recommended by Amazon when searching this keyword Example: 1 |
data.data[].editorialRecommendationsProductCount | integer | optional | Editorial Recommendations product count. Number of products appearing in the editorial recommendation placement for this keyword Example: 1 |
data.data[].recNonadProductCount | integer | optional | Recommendation placement non-ad product count. Number of non-ad (organic) products in recommendation placements for this keyword Example: 1 |
data.data[].recAdProductCount | integer | optional | Recommendation placement ad product count. Number of ad products in recommendation placements for this keyword Example: 1 |
data.data[].trackedAsinTotalCount | integer | optional | SIF tracked ASIN deduplicated total count. Deduplicated count of ASINs that SIF has tracked with exposure scores across all positions (natural/ad/recommendation) for this keyword (upstream field: totalAsinNum) Example: 1 |
data.data[].totalMarketplaceKeywordCount | integer | optional | Total marketplace keyword count. Total number of keywords for this site, used to understand overall market size Example: 1 |
data.data[].dataPeriodStartDate | string | optional | Data period start date. ABA week start date corresponding to the returned data (yyyy-MM-dd) Example: 2026-01-01 |
data.data[].dataPeriodEndDate | string | optional | Data period end date. ABA week end date corresponding to the returned data (yyyy-MM-dd) Example: 2026-01-01 |
data.data[].keywordDataUpdateTime | string | optional | Keyword data update time Example: phone case |
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
data.sourceTool | string | optional | Provider-specific source tool name. 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": [
{
"keyword": "phone case",
"keywordPopularityRank": 1,
"estimatedWeeklySearchVolume": 1,
"supplyDemandRatio": 1,
"totalSearchResultProductCount": 1,
"naturalSearchProductCount": 1,
"sponsoredProductsCount": 1,
"brandAdProductCount": 1,
"videoAdProductCount": 1,
"paidAdvertisingProductCount": 1,
"amazonChoiceProductCount": 1,
"topRatedProductCount": 1,
"searchRecommendationProductCount": 1,
"editorialRecommendationsProductCount": 1,
"recNonadProductCount": 1,
"recAdProductCount": 1,
"trackedAsinTotalCount": 1,
"totalMarketplaceKeywordCount": 1,
"dataPeriodStartDate": "2026-01-01",
"dataPeriodEndDate": "2026-01-01",
"keywordDataUpdateTime": "phone case"
}
],
"costTime": 1,
"costToken": 1,
"columns": []
},
"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.