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 |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (53 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Total number of items |
marketplace | string | optional | market code |
asin | string | optional | Query ASIN |
data | array | optional | Traffic word list (corresponding to third-party `data.items`) |
summaryList | array | optional | High frequency word summary list |
columns | array | optional | Column definition |
costToken | integer | optional | Consume token |
type | string | optional | rendering style |
total | integer | optional | Total times |
keywords | string | optional | word |
keyword | string | optional | keywords |
keywordCn | string | optional | Keywords Chinese translation |
trafficKeywordType | string | optional | Traffic proportion type |
conversionKeywordType | string | optional | Traffic conversion type |
badges | array | optional | Exposure position (traffic word type) |
rankPosition | object | optional | Natural ranking position information, see ranking object for structure |
adPosition | object | optional | Ad ranking information, the structure is the same as the ranking object |
searches | integer | optional | Monthly searches |
searchesRank | integer | optional | Weekly search volume ranking |
searchesRankTimeFrom | integer | optional | Weekly search volume ranking time range from |
searchesRankTimeTo | integer | optional | Weekly search volume ranking time range ends |
purchases | integer | optional | Monthly purchase volume |
purchaseRate | number | optional | purchase rate |
products | integer | optional | Number of items |
supplyDemandRatio | number | optional | Supply and demand ratio |
trafficPercentage | number | optional | Traffic proportion |
naturalRatio | number | optional | Traffic distribution-natural proportion |
adRatio | number | optional | Traffic distribution-advertising proportion |
calculatedWeeklySearches | number | optional | Estimated weekly exposure |
impressions | integer | optional | Impression volume |
clicks | integer | optional | Clicks |
bid | number | optional | PPC bidding |
bidMin | number | optional | PPC bid minimum |
bidMax | number | optional | PPC bid cap |
latest1daysAds | integer | optional | Number of advertising competitors in the last day |
latest7daysAds | integer | optional | Number of advertising competitors in the last 7 days |
latest30daysAds | integer | optional | Number of competing advertising products in the last 30 days |
sprt | number | optional | SP correlation ratio |
monopolyClickRate | number | optional | Monopoly click rate |
top3ClickingRate | number | optional | Top3 click rate |
top3ConversionRate | number | optional | Top3 conversion rate |
titleDensity | number | optional | title density |
stats | array | optional | High-frequency words, the elements are shown in the table below |
updatedTime | integer | optional | Update time |
keywords | string | optional | word |
total | integer | optional | Total number of items |
rankPosition | object | optional | Natural ranking position, see ranking object for structure |
adPosition | object | optional | Ad ranking position, see ranking object for structure |
updatedTime | integer | optional | Ranking time |
pageSize | integer | optional | How many pieces of data per page |
index | integer | optional | What is the current page ranking? |
page | integer | optional | Which page |
position | integer | optional | What is the ranking among the total results? |
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.