https://api.nexscope.ai/api/skill-api/v1/skills/amazon-keyword-summary/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-summary/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
searchKeyword | string | required | Search 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 |
asins | string | optional | ASIN filter list, comma-separated; if not provided, returns all ASINs for this keyword. Max length 1000 characters Example: B072MQ5BRX |
condition | string | optional | Condition filter, only one at a time.<br>Flag type: nfPosition (natural traffic keyword), isSpAd (SP ad keyword), isVedioAd (video ad keyword), isBrandAd (brand ad keyword), isPPCAd (PPC ad keyword), isSearchRecommend (search recommendation keyword), acAd (SP recommendation)<br>Period count type: totalPeriod.in (new incoming traffic keywords), nfKeywordCnt.total / .in, adKeywordCnt.total / .in, allSpKeywordCnt.total / .in, spKeywordCnt.total / .in, recSpKeywordCnt.total / .in, allSbKeywordCnt.total / .in, sbKeywordCnt.total / .in, sbvKeywordCnt.total / .in |
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; if omitted, the latest system full week is used) Example: 2026-01-01 |
endDate | string | optional | End date yyyy-MM-dd (paired with startDate) Example: 2026-01-01 |
sortBy | string | optional | Sort field. Options: totalKeywordNum (all traffic keywords), naturalKeywordNum (natural traffic keywords), brandKeywordNum (brand ad keywords), vedioKeywordNum (video ad keywords), acKeywordNum (AC recommended keywords), erKeywordNum (ER recommended keywords), trKeywordNum (TR recommended keywords), sumScore (total keyword exposure score), totalNfScore, totalSpSocre (note spelling), totalBrandScore, totalVedioScore, totalAcScore, totalTrScore, totalErScore |
pageNum | integer | optional | Page number, default 1 Example: 1 |
pageSize | integer | optional | Results per page, min 10, max 100, default 100 Example: 10 |
desc | boolean | optional | Whether to sort descending, default true Example: true |
Code example
{
"country": "US",
"last7d": true,
"pageNum": 1,
"pageSize": 10,
"searchKeyword": "phone case"
}Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"columns": [],
"costTime": 1,
"costToken": 1,
"data": [
{
"amazonRecommendationSources": [],
"amazonsChoiceExposureRatio": 1,
"amazonsChoiceExposureScore": 1,
"asin": "B072MQ5BRX",
"brandAdExposureRatio": 1,
"brandAdExposureScore": 1,
"comprehensiveNaturalExposureRatio": 1,
"comprehensiveNaturalExposureScore": 1,
"customerRatingCount": 1,
"dataPeriodStartDate": "2026-01-01",
"editorialRecommendationsExposureRatio": 1,
"editorialRecommendationsExposureScore": 1,
"keywordAmazonsChoiceExposureScore": 1,
"keywordBrandAdExposureScore": 1,
"keywordComprehensiveNaturalExposureScore": 1,
"keywordNaturalExposureScore": 1,
"keywordRecommendAdExposureScore": 1,
"keywordRecommendExposureScore": 1,
"keywordRecommendNonadExposureScore": 1,
"keywordSponsoredProductsExposureScore": 1,
"keywordTotalExposureScore": 1,
"keywordVideoAdExposureScore": 1,
"naturalSearchExposureRatio": 1,
"naturalSearchExposureScore": 1,
"naturalSearchTrafficSources": [],
"ppcTrafficSources": [],
"productImageUrl": "https://example.com/image.jpg",
"productPrice": 1,
"productRatingScore": 1,
"productStarRating": 1,
"productUpdateTime": "2026-01-01",
"promotionalDealSources": [],
"recommendAdExposureRatio": 1,
"recommendAdExposureScore": 1,
"recommendNonadExposureRatio": 1,
"recommendNonadExposureScore": 1,
"recommendPositionExposureScore": 1,
"sponsoredProductsExposureRatio": 1,
"sponsoredProductsExposureScore": 1,
"topRatedExposureRatio": 1,
"topRatedExposureScore": 1,
"totalExposureRatio": 1,
"totalExposureScore": 1,
"videoAdExposureRatio": 1,
"videoAdExposureScore": 1
}
],
"total": 1
},
"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 | array | optional | Render columns Example: [] |
data.costTime | integer | optional | Latency (ms) Example: 1 |
data.costToken | integer | optional | Tokens consumed Example: 1 |
data.data | array | optional | Return data, array of product keyword traffic data objects Example: [] |
data.data[] | object | required | Item in data data. |
data.data[].amazonRecommendationSources | array | optional | Amazon recommendation traffic source markers. Contains: Best Seller, AC, ER, TR, TRFOB, etc. Example: [] |
data.data[].amazonsChoiceExposureRatio | number | optional | AC exposure ratio Example: 1 |
data.data[].amazonsChoiceExposureScore | number | optional | AC exposure total score Example: 1 |
data.data[].asin | string | optional | ASIN code Example: B072MQ5BRX |
data.data[].brandAdExposureRatio | number | optional | Brand ad exposure ratio Example: 1 |
data.data[].brandAdExposureScore | number | optional | Brand ad exposure total score Example: 1 |
data.data[].comprehensiveNaturalExposureRatio | number | optional | Comprehensive natural traffic share Example: 1 |
data.data[].comprehensiveNaturalExposureScore | number | optional | Comprehensive natural traffic score (natural search + recommendation non-ad) Example: 1 |
data.data[].customerRatingCount | integer | optional | Total customer rating count Example: 1 |
data.data[].dataPeriodStartDate | string | optional | Data period start date (yyyy-MM-dd) Example: 2026-01-01 |
data.data[].editorialRecommendationsExposureRatio | number | optional | ER exposure ratio Example: 1 |
data.data[].editorialRecommendationsExposureScore | number | optional | ER exposure total score Example: 1 |
data.data[].keywordAmazonsChoiceExposureScore | number | optional | Keyword AC score Example: 1 |
data.data[].keywordBrandAdExposureScore | number | optional | Keyword brand ad score Example: 1 |
data.data[].keywordComprehensiveNaturalExposureScore | number | optional | Keyword comprehensive natural score (natural + recommendation non-ad) Example: 1 |
data.data[].keywordNaturalExposureScore | number | optional | Keyword natural score Example: 1 |
data.data[].keywordRecommendAdExposureScore | number | optional | Keyword recommendation position ad score Example: 1 |
data.data[].keywordRecommendExposureScore | number | optional | Keyword recommendation position score Example: 1 |
data.data[].keywordRecommendNonadExposureScore | number | optional | Keyword recommendation position non-ad score Example: 1 |
data.data[].keywordSponsoredProductsExposureScore | number | optional | Keyword SP ad score Example: 1 |
data.data[].keywordTotalExposureScore | number | optional | Keyword total score Example: 1 |
data.data[].keywordVideoAdExposureScore | number | optional | Keyword video ad score Example: 1 |
data.data[].naturalSearchExposureRatio | number | optional | Natural search exposure ratio Example: 1 |
data.data[].naturalSearchExposureScore | number | optional | Natural search exposure total score Example: 1 |
data.data[].naturalSearchTrafficSources | array | optional | Natural search traffic source markers Example: [] |
data.data[].ppcTrafficSources | array | optional | PPC paid ad traffic source markers. Contains: SP ads, top brand ads, bottom brand ads, video ads Example: [] |
data.data[].productImageUrl | string | optional | Product main image URL Example: https://example.com/image.jpg |
data.data[].productPrice | number | optional | Product price Example: 1 |
data.data[].productRatingScore | number | optional | Product rating score value Example: 1 |
data.data[].productStarRating | number | optional | Product star rating (0-5 stars) Example: 1 |
data.data[].productTitle | string | optional | Product title Example: null |
data.data[].productUpdateTime | string | optional | Product update time (yyyy-MM-dd HH:mm:ss) Example: 2026-01-01 |
data.data[].promotionalDealSources | array | optional | Promotional deal traffic source markers. Contains: Coupon, Limited Time Deal, Lowest Price in 30 Days, etc. Example: [] |
data.data[].recommendAdExposureRatio | number | optional | Recommendation position ad traffic share Example: 1 |
data.data[].recommendAdExposureScore | number | optional | Recommendation position ad exposure score Example: 1 |
data.data[].recommendNonadExposureRatio | number | optional | Recommendation position non-ad traffic share Example: 1 |
data.data[].recommendNonadExposureScore | number | optional | Recommendation position non-ad exposure score Example: 1 |
data.data[].recommendPositionExposureScore | number | optional | Recommendation position exposure total score Example: 1 |
data.data[].sponsoredProductsExposureRatio | number | optional | SP ad exposure ratio Example: 1 |
data.data[].sponsoredProductsExposureScore | number | optional | SP ad exposure total score Example: 1 |
data.data[].topRatedExposureRatio | number | optional | TR exposure ratio Example: 1 |
data.data[].topRatedExposureScore | number | optional | TR exposure total score Example: 1 |
data.data[].totalExposureRatio | number | optional | Total traffic share Example: 1 |
data.data[].totalExposureScore | number | optional | Total exposure score Example: 1 |
data.data[].videoAdExposureRatio | number | optional | Video ad exposure ratio Example: 1 |
data.data[].videoAdExposureScore | number | optional | Video ad exposure total score Example: 1 |
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
data.page | integer | optional | Current page 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.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
data.title | string | optional | Title Example: null |
data.total | integer | optional | Number of data records actually returned Example: 1 |
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
data.type | string | optional | Render style Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
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.