https://api.nexscope.ai/sf/asinSummaryRun 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/asinSummary |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
searchValue | string | required | ASIN codes, multiple separated by commas, up to 10, maximum length 1000 characters |
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` |
conditions | string | optional | Comma separated: `nf`, `sp`, `sb`, `sbv`, `ad`, `acAd`, `totalPeriod.in` |
sortBy | string | optional | `totalKeywordNum`γ`naturalKeywordNum`γ`brandKeywordNum`γ`vedioKeywordNum`γ`acKeywordNum`γ`erKeywordNum`γ`trKeywordNum`γ`sumScore`γ`totalNfScore`γ`totalSpSocre`γ`totalBrandScore`γ`totalVedioScore`γ`totalAcScore`γ`totalTrScore`γ`totalErScore` |
pageNum | integer | optional | Page number Example: 1 |
pageSize | integer | optional | Number per page, range 10β10000 Example: 10000 |
desc | boolean | optional | Is descending order Example: true |
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 (77 fields)
| Name | Type | Required | Description |
|---|---|---|---|
code | string | optional | return code |
msg | string | optional | news |
total | integer | optional | The actual amount of data returned this time |
data | array | optional | ASIN summary object array (Field suffix convention: `*Prev` is the value of the previous period; `*In` / `*Out` is the number of new entries/exits in this cycle relative to the previous period) |
columns | array | optional | render column |
type | string | optional | rendering style |
title | string | optional | Title |
isParentAsin | boolean | optional | Whether the search object is a parent ASIN |
variantsNum | integer | optional | Number of variations with keywords |
noKeywordVariantsNum | integer | optional | Number of variations without keywords |
costTime | integer | optional | Time consuming (ms) |
costToken | integer | optional | Consume token |
asin | string | optional | ASIN code |
productTitle | string | optional | Product title |
productCategory | string | optional | Product category |
productPrice | number | optional | Product selling price |
productImageUrl | string | optional | Main image URL |
productFeatures | array | optional | Product feature list |
customerRatingCount | integer | optional | Total customer ratings |
productStarRating | number | optional | Product star rating (0β5) |
productRatingScore | number | optional | Product rating value (0β5) |
isVariantProduct | boolean | optional | Is it a variant? |
recentMonthlySalesBucket | string | optional | Sales bucket in the past month; this field only has a value in the `keywordSummary` path, in the form of `"300+"` or `"1,000+"` |
isMonitored | boolean | optional | Has it been monitored? |
monitoringStartTime | string | optional | attention time |
dataPeriodStartDate | string | optional | Data period start date |
totalExposureScore | number | optional | Total exposure score |
totalExposureScorePrev | number | optional | Total exposure score last cycle |
totalTrafficKeywordCount | integer | optional | Total number of traffic keywords |
totalTrafficKeywordCountIn | integer | optional | Number of new traffic keywords this cycle |
totalTrafficKeywordCountOut | integer | optional | Number of exit traffic keywords this cycle |
totalTrafficKeywordCountPrev | integer | optional | Total number of traffic keywords in the last cycle |
naturalSearchExposureScore | number | optional | Total organic search exposure score |
naturalSearchExposureRatio | number | optional | Natural search exposure ratio |
naturalSearchExposureScorePrev | number | optional | Natural search exposure score last cycle |
naturalSearchKeywordCount | integer | optional | Number of natural search keywords |
naturalSearchKeywordCountIn | integer | optional | Number of new natural keywords this cycle |
naturalSearchKeywordCountOut | integer | optional | Number of natural keywords exiting this cycle |
naturalSearchKeywordCountPrev | integer | optional | Number of natural keywords in the previous cycle |
sponsoredProductsExposureScore | number | optional | SP ad impression total score |
sponsoredProductsExposureRatio | number | optional | SP advertising exposure ratio |
sponsoredProductsExposureScorePrev | number | optional | Last cycle SP exposure score |
sponsoredProductsKeywordCount | integer | optional | SP number of advertising keywords |
brandAdExposureScore | number | optional | Total brand advertising exposure score |
brandAdExposureRatio | number | optional | Brand advertising exposure proportion |
brandAdExposureScorePrev | number | optional | Brand advertising exposure score last cycle |
brandAdKeywordCount | integer | optional | Number of brand advertising keywords |
topBrandAdKeywordCount | integer | optional | Number of top brand ad keywords |
bottomBrandAdKeywordCount | integer | optional | Number of keywords for brand ads at the bottom |
videoAdExposureScore | number | optional | Total video ad exposure score |
videoAdExposureRatio | number | optional | Video ad exposure ratio |
videoAdExposureScorePrev | number | optional | Video ad exposure score last cycle |
videoAdKeywordCount | integer | optional | Number of video ad keywords |
amazonsChoiceExposureScore | number | optional | Amazon's Choice Impression Total Score |
amazonsChoiceExposureRatio | number | optional | Amazon's Choice impression share |
amazonsChoiceExposureScorePrev | number | optional | Last cycle AC exposure score |
amazonsChoiceKeywordCount | integer | optional | AC keyword count |
amazonsChoiceKeywordCountIn | integer | optional | Number of new AC keywords in this cycle |
amazonsChoiceKeywordCountOut | integer | optional | Number of AC keywords exiting this cycle |
editorialRecommendationsExposureScore | number | optional | ER total exposure score |
editorialRecommendationsExposureRatio | number | optional | ER exposure ratio |
editorialRecommendationsKeywordCount | integer | optional | ER keyword count |
topRatedExposureScore | number | optional | TR Recommended exposure total score |
topRatedExposureRatio | number | optional | TR recommended exposure ratio |
topRatedKeywordCount | integer | optional | TR keyword count |
frequentlyBoughtKeywordCount | integer | optional | Number of recommended keywords for high-frequency purchases |
recommendPositionExposureScore | number | optional | Recommended position exposure total score |
recommendAdExposureScore | number | optional | Recommended advertising exposure score |
recommendNonadExposureScore | number | optional | Recommended position non-advertising exposure score |
nonAcRecommendExposureScore | number | optional | Non-AC recommended position exposure score |
recommendKeywordCount | integer | optional | Total number of recommended keywords |
recommendAdKeywordCount | integer | optional | Number of recommended advertising keywords |
recommendNonadKeywordCount | integer | optional | Number of recommended non-advertising keywords |
ppcTrafficSources | array | optional | PPC Traffic Source Tags |
naturalSearchTrafficSources | array | optional | Organic search traffic source tag |
amazonRecommendationSources | array | optional | Amazon Recommended Source Mark |
promotionalDealSources | array | optional | Promotion source tag |
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.