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` |
Code example
{
"country": "US",
"keyword": "wireless charger"
}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.amazonChoiceProductCount | any | optional | Amazon choice product count value used by this API operation. |
data.brandAdProductCount | any | optional | Brand ad product count value used by this API operation. |
data.columns | any | optional | Columns 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.dataPeriodEndDate | any | optional | Data period end date value used by this API operation. |
data.dataPeriodStartDate | any | optional | Data period start date value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.editorialRecommendationsProductCount | any | optional | Editorial recommendations product count value used by this API operation. |
data.estimatedWeeklySearchVolume | any | optional | Estimated weekly search volume value used by this API operation. |
data.keyword | any | optional | Keyword value used by this API operation. |
data.keywordDataUpdateTime | any | optional | Keyword data update time value used by this API operation. |
data.keywordPopularityRank | any | optional | Keyword popularity rank value used by this API operation. |
data.naturalSearchProductCount | any | optional | Natural search product count 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.paidAdvertisingProductCount | any | optional | Paid advertising product count value used by this API operation. |
data.recAdProductCount | any | optional | Rec ad product count value used by this API operation. |
data.recNonadProductCount | any | optional | Rec nonad product count value used by this API operation. |
data.searchRecommendationProductCount | any | optional | Search recommendation product count 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.sponsoredProductsCount | any | optional | Sponsored products count 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.topRatedProductCount | any | optional | Top rated product count value used by this API operation. |
data.total | any | optional | Total value used by this API operation. |
data.totalMarketplaceKeywordCount | any | optional | Total marketplace keyword count value used by this API operation. |
data.totalPage | any | optional | Total page value used by this API operation. |
data.totalSearchResultProductCount | any | optional | Total search result product count value used by this API operation. |
data.trackedAsinTotalCount | any | optional | Tracked asin total count value used by this API operation. |
data.type | any | optional | Type value used by this API operation. |
data.videoAdProductCount | any | optional | Video ad product count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonChoiceProductCount | integer | optional | Amazon's Choice item count Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonChoiceProductCount | null | optional | Amazon choice product count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.brandAdProductCount | integer | optional | Number of brand advertising products Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.brandAdProductCount | null | optional | Brand ad product count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | array | optional | render column 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.costTime | integer | optional | Time consuming (ms) 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 | keyword overview array 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.dataPeriodEndDate | string | optional | Data period end date Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dataPeriodEndDate | null | optional | Data period end date value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.dataPeriodStartDate | string | optional | Data period start date Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dataPeriodStartDate | null | optional | Data period start date 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.editorialRecommendationsProductCount | integer | optional | Number of items recommended by editors Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.editorialRecommendationsProductCount | null | optional | Editorial recommendations product count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.estimatedWeeklySearchVolume | integer | optional | Estimated search volume per week Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.estimatedWeeklySearchVolume | null | optional | Estimated weekly search volume 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.keywordDataUpdateTime | string | optional | Keyword data update time Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordDataUpdateTime | null | optional | Keyword data update time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordPopularityRank | integer | optional | Keyword popularity ranking. The smaller the value, the greater the search volume. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordPopularityRank | null | optional | Keyword popularity rank value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchProductCount | integer | optional | Number of natural search items Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchProductCount | null | optional | Natural search product count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.page | integer | optional | Current page returned by the upstream provider. 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 | Page size returned by the upstream provider. 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.paidAdvertisingProductCount | integer | optional | Total number of PPC paid advertising products Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.paidAdvertisingProductCount | null | optional | Paid advertising product count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.recAdProductCount | integer | optional | Number of recommended advertising products Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.recAdProductCount | null | optional | Rec ad product count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.recNonadProductCount | integer | optional | Number of recommended non-advertising products Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.recNonadProductCount | null | optional | Rec nonad product count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.searchRecommendationProductCount | integer | optional | Search the number of recommended products Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.searchRecommendationProductCount | null | optional | Search recommendation product count 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.sponsoredProductsCount | integer | optional | SP number of advertised items Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredProductsCount | null | optional | Sponsored products count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.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. 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 | 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.topRatedProductCount | integer | optional | Top Rated number of items Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.topRatedProductCount | null | optional | Top rated product count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.total | integer | optional | Total amount of data, usually 1 Example: null |
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.totalMarketplaceKeywordCount | integer | optional | Total number of site keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalMarketplaceKeywordCount | null | optional | Total marketplace keyword count 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.totalSearchResultProductCount | integer | optional | Total number of search results items Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalSearchResultProductCount | null | optional | Total search result product count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.trackedAsinTotalCount | integer | optional | The total number of exposed ASIN deduplication tracked by sf; the upstream field is `totalAsinNum` Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.trackedAsinTotalCount | null | optional | Tracked asin total count 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.videoAdProductCount | integer | optional | Number of video advertising products Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.videoAdProductCount | null | optional | Video ad product count 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.