https://api.nexscope.ai/sf/keywordOverviewRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/sf/keywordOverview |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | required | Keywords, maximum length 1000; try to use target site language |
country | string | optional | Site: `US`, `UK`, `DE`, `CA`, `JP`, `FR`, `ES`, `IT`, `MX`, `AU`, `AE`, `BR`, `SA` Example: US |
last7d | boolean | optional | Whether to take the last 7 days; when it is `false`, use the date range Example: true |
startDate | string | optional | `yyyy-MM-dd`; takes effect when `last7d=false` |
endDate | string | optional | `yyyy-MM-dd`; works with `startDate` |
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 (30 fields)
| Name | Type | Required | Description |
|---|---|---|---|
msg | string | optional | news |
total | integer | optional | Total amount of data, usually 1 |
code | string | optional | sf business return code, `"1"` indicates success |
data | array | optional | keyword overview array |
costTime | integer | optional | Time consuming (ms) |
costToken | integer | optional | Consume token |
columns | array | optional | render column |
type | string | optional | rendering style |
title | string | optional | Title |
keyword | string | optional | keywords |
keywordPopularityRank | integer | optional | Keyword popularity ranking. The smaller the value, the greater the search volume. |
estimatedWeeklySearchVolume | integer | optional | Estimated search volume per week |
supplyDemandRatio | number | optional | Supply and demand ratio (number of search results products / monthly search volume), the smaller the value, the smaller the competition and the greater the opportunity. |
totalSearchResultProductCount | integer | optional | Total number of search results items |
naturalSearchProductCount | integer | optional | Number of natural search items |
sponsoredProductsCount | integer | optional | SP number of advertised items |
brandAdProductCount | integer | optional | Number of brand advertising products |
videoAdProductCount | integer | optional | Number of video advertising products |
paidAdvertisingProductCount | integer | optional | Total number of PPC paid advertising products |
amazonChoiceProductCount | integer | optional | Amazon's Choice item count |
topRatedProductCount | integer | optional | Top Rated number of items |
searchRecommendationProductCount | integer | optional | Search the number of recommended products |
editorialRecommendationsProductCount | integer | optional | Number of items recommended by editors |
recNonadProductCount | integer | optional | Number of recommended non-advertising products |
recAdProductCount | integer | optional | Number of recommended advertising products |
trackedAsinTotalCount | integer | optional | The total number of exposed ASIN deduplication tracked by sf; the upstream field is `totalAsinNum` |
totalMarketplaceKeywordCount | integer | optional | Total number of site keywords |
dataPeriodStartDate | string | optional | Data period start date |
dataPeriodEndDate | string | optional | Data period end date |
keywordDataUpdateTime | string | optional | Keyword data update time |
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.