https://api.nexscope.ai/ss/traffic/keywordRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/ss/traffic/keyword |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
marketplace | string | required | Market site, see marketplace optional value Example: US |
asin | string | required | Product ASIN to be reverse-checked, maxLength 1000 |
month | string | optional | Historical month, format `yyyyMM` |
page | integer | optional | Current page Example: 1 |
size | integer | optional | Number of items per page, minimum 1, maximum 100, maximum query 2000 Example: 50 |
keyword | string | optional | Keyword filtering, maxLength 1000 |
badges | string | optional | Exposure position, multiple values are separated by commas, see badges enumeration |
trafficKeywordTypes | string | optional | Traffic proportion type, multiple values are separated by English commas, see trafficKeywordTypes enumeration |
conversionKeywordTypes | string | optional | Traffic conversion type, multiple values are separated by English commas, see conversionKeywordTypes enumeration |
orderField | string | optional | Ordering field, see orderField optional value Example: rankPosition |
orderDesc | boolean | optional | Sort in reverse order Example: false |
Code example
{
"asin": "B0XXXXXXXXX",
"marketplace": "US",
"page": 1,
"size": 50
}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.adPosition | any | optional | Ad position value used by this API operation. |
data.adRatio | any | optional | Ad ratio value used by this API operation. |
data.asin | any | optional | Asin value used by this API operation. |
data.badges | any | optional | Badges value used by this API operation. |
data.bid | any | optional | Bid value used by this API operation. |
data.bidMax | any | optional | Bid max value used by this API operation. |
data.bidMin | any | optional | Bid min value used by this API operation. |
data.calculatedWeeklySearches | any | optional | Calculated weekly searches value used by this API operation. |
data.clicks | any | optional | Clicks value used by this API operation. |
data.columns | any | optional | Columns value used by this API operation. |
data.conversionKeywordType | any | optional | Conversion keyword type 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.impressions | any | optional | Impressions value used by this API operation. |
data.index | any | optional | Index value used by this API operation. |
data.keyword | any | optional | Keyword value used by this API operation. |
data.keywordCn | any | optional | Keyword cn value used by this API operation. |
data.keywords | any | optional | Keywords value used by this API operation. |
data.latest1daysAds | any | optional | Latest1days ads value used by this API operation. |
data.latest30daysAds | any | optional | Latest30days ads value used by this API operation. |
data.latest7daysAds | any | optional | Latest7days ads value used by this API operation. |
data.marketplace | any | optional | Marketplace value used by this API operation. |
data.monopolyClickRate | any | optional | Monopoly click rate value used by this API operation. |
data.naturalRatio | any | optional | Natural ratio 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.position | any | optional | Position value used by this API operation. |
data.products | any | optional | Products value used by this API operation. |
data.purchaseRate | any | optional | Purchase rate value used by this API operation. |
data.purchases | any | optional | Purchases value used by this API operation. |
data.rankPosition | any | optional | Rank position value used by this API operation. |
data.searches | any | optional | Searches value used by this API operation. |
data.searchesRank | any | optional | Searches rank value used by this API operation. |
data.searchesRankTimeFrom | any | optional | Searches rank time from value used by this API operation. |
data.searchesRankTimeTo | any | optional | Searches rank time to 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.sprt | any | optional | Sprt value used by this API operation. |
data.stats | any | optional | Stats value used by this API operation. |
data.summaryList | any | optional | Summary list value used by this API operation. |
data.supplyDemandRatio | any | optional | Supply demand ratio value used by this API operation. |
data.title | any | optional | Title value used by this API operation. |
data.titleDensity | any | optional | Title density value used by this API operation. |
data.top3ClickingRate | any | optional | Top3 clicking rate value used by this API operation. |
data.top3ConversionRate | any | optional | Top3 conversion rate 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.trafficKeywordType | any | optional | Traffic keyword type value used by this API operation. |
data.trafficPercentage | any | optional | Traffic percentage value used by this API operation. |
data.type | any | optional | Type value used by this API operation. |
data.updatedTime | any | optional | Updated time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.adPosition | any | optional | Ad position value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.adPosition | object | optional | Ad ranking position, see ranking object for structure Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.adPosition | null | optional | Ad position value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.adPosition | null | optional | Ad position value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.adRatio | number | optional | Traffic distribution-advertising proportion Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.adRatio | null | optional | Ad ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.asin | string | optional | Query ASIN Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.asin | null | optional | Asin value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.badges | array | optional | Exposure position (traffic word type) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.badges | null | optional | Badges value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.bid | number | optional | PPC bidding Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.bid | null | optional | Bid value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.bidMax | number | optional | PPC bid cap Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.bidMax | null | optional | Bid max value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.bidMin | number | optional | PPC bid minimum Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.bidMin | null | optional | Bid min value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.calculatedWeeklySearches | number | optional | Estimated weekly exposure Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.calculatedWeeklySearches | null | optional | Calculated weekly searches value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.clicks | integer | optional | Clicks Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.clicks | null | optional | Clicks value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | array | optional | Column definition 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.conversionKeywordType | string | optional | Traffic conversion type Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.conversionKeywordType | null | optional | Conversion keyword type 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 | Traffic word list (corresponding to third-party `data.items`) 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.impressions | integer | optional | Impression volume Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.impressions | null | optional | Impressions value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.index | integer | optional | What is the current page ranking? Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.index | null | optional | Index 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.keywordCn | string | optional | Keywords Chinese translation Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordCn | null | optional | Keyword cn value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywords | any | optional | Keywords value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywords | string | optional | word Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywords | null | optional | Keywords value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywords | null | optional | Keywords value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.latest1daysAds | integer | optional | Number of advertising competitors in the last day Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.latest1daysAds | null | optional | Latest1days ads value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.latest30daysAds | integer | optional | Number of competing advertising products in the last 30 days Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.latest30daysAds | null | optional | Latest30days ads value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.latest7daysAds | integer | optional | Number of advertising competitors in the last 7 days Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.latest7daysAds | null | optional | Latest7days ads value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.marketplace | string | optional | market code Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.marketplace | null | optional | Marketplace value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.monopolyClickRate | number | optional | Monopoly click rate Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.monopolyClickRate | null | optional | Monopoly click rate value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalRatio | number | optional | Traffic distribution-natural proportion Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalRatio | null | optional | Natural ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.page | integer | optional | Which page 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 | How many pieces of data per page 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.position | integer | optional | What is the ranking among the total results? Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.position | null | optional | Position value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.products | integer | optional | Number of items Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.products | null | optional | Products value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.purchaseRate | number | optional | purchase rate Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.purchaseRate | null | optional | Purchase rate value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.purchases | integer | optional | Monthly purchase volume Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.purchases | null | optional | Purchases value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.rankPosition | any | optional | Rank position value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.rankPosition | object | optional | Natural ranking position, see ranking object for structure Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.rankPosition | null | optional | Rank position value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.rankPosition | null | optional | Rank position value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.searches | integer | optional | Monthly searches Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.searches | null | optional | Searches value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.searchesRank | integer | optional | Weekly search volume ranking Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.searchesRank | null | optional | Searches rank value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.searchesRankTimeFrom | integer | optional | Weekly search volume ranking time range from Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.searchesRankTimeFrom | null | optional | Searches rank time from value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.searchesRankTimeTo | integer | optional | Weekly search volume ranking time range ends Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.searchesRankTimeTo | null | optional | Searches rank time to 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.sprt | number | optional | SP correlation ratio Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sprt | null | optional | Sprt value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.stats | array | optional | High-frequency words, the elements are shown in the table below Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.stats | null | optional | Stats value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.summaryList | array | optional | High frequency word summary list Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.summaryList | null | optional | Summary list value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.supplyDemandRatio | number | optional | Supply and demand ratio Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.supplyDemandRatio | null | optional | Supply demand ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.title | string | optional | Provider-specific response 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.titleDensity | number | optional | title density Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.titleDensity | null | optional | Title density value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.top3ClickingRate | number | optional | Top3 click rate Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.top3ClickingRate | null | optional | Top3 clicking rate value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.top3ConversionRate | number | optional | Top3 conversion rate Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.top3ConversionRate | null | optional | Top3 conversion rate value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.total | any | optional | Total value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.total | any | optional | Total value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.total | integer | optional | Total number of items Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.total | null | optional | Total value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.total | null | optional | Total value used by this API operation. |
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.trafficKeywordType | string | optional | Traffic proportion type Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.trafficKeywordType | null | optional | Traffic keyword type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.trafficPercentage | number | optional | Traffic proportion Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.trafficPercentage | null | optional | Traffic percentage 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 1
| Name | Type | Required | Description |
|---|---|---|---|
data.updatedTime | any | optional | Updated time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.updatedTime | integer | optional | Ranking time Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.updatedTime | null | optional | Updated time value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.updatedTime | null | optional | Updated time 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.