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 |
Code example
{
"country": "US",
"pageSize": 10000,
"searchValue": "B09V3KXJPB,B0BN1K7WJP"
}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.amazonRecommendationSources | any | optional | Amazon recommendation sources value used by this API operation. |
data.amazonsChoiceExposureRatio | any | optional | Amazons choice exposure ratio value used by this API operation. |
data.amazonsChoiceExposureScore | any | optional | Amazons choice exposure score value used by this API operation. |
data.amazonsChoiceExposureScorePrev | any | optional | Amazons choice exposure score prev value used by this API operation. |
data.amazonsChoiceKeywordCount | any | optional | Amazons choice keyword count value used by this API operation. |
data.amazonsChoiceKeywordCountIn | any | optional | Amazons choice keyword count in value used by this API operation. |
data.amazonsChoiceKeywordCountOut | any | optional | Amazons choice keyword count out value used by this API operation. |
data.asin | any | optional | Asin value used by this API operation. |
data.bottomBrandAdKeywordCount | any | optional | Bottom brand ad keyword count value used by this API operation. |
data.brandAdExposureRatio | any | optional | Brand ad exposure ratio value used by this API operation. |
data.brandAdExposureScore | any | optional | Brand ad exposure score value used by this API operation. |
data.brandAdExposureScorePrev | any | optional | Brand ad exposure score prev value used by this API operation. |
data.brandAdKeywordCount | any | optional | Brand ad keyword 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.customerRatingCount | any | optional | Customer rating count value used by this API operation. |
data.data | any | optional | Data 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.editorialRecommendationsExposureRatio | any | optional | Editorial recommendations exposure ratio value used by this API operation. |
data.editorialRecommendationsExposureScore | any | optional | Editorial recommendations exposure score value used by this API operation. |
data.editorialRecommendationsKeywordCount | any | optional | Editorial recommendations keyword count value used by this API operation. |
data.frequentlyBoughtKeywordCount | any | optional | Frequently bought keyword count value used by this API operation. |
data.isMonitored | any | optional | Is monitored value used by this API operation. |
data.isParentAsin | any | optional | Is parent asin value used by this API operation. |
data.isVariantProduct | any | optional | Is variant product value used by this API operation. |
data.monitoringStartTime | any | optional | Monitoring start time value used by this API operation. |
data.naturalSearchExposureRatio | any | optional | Natural search exposure ratio value used by this API operation. |
data.naturalSearchExposureScore | any | optional | Natural search exposure score value used by this API operation. |
data.naturalSearchExposureScorePrev | any | optional | Natural search exposure score prev value used by this API operation. |
data.naturalSearchKeywordCount | any | optional | Natural search keyword count value used by this API operation. |
data.naturalSearchKeywordCountIn | any | optional | Natural search keyword count in value used by this API operation. |
data.naturalSearchKeywordCountOut | any | optional | Natural search keyword count out value used by this API operation. |
data.naturalSearchKeywordCountPrev | any | optional | Natural search keyword count prev value used by this API operation. |
data.naturalSearchTrafficSources | any | optional | Natural search traffic sources value used by this API operation. |
data.noKeywordVariantsNum | any | optional | No keyword variants num value used by this API operation. |
data.nonAcRecommendExposureScore | any | optional | Non ac recommend exposure score 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.ppcTrafficSources | any | optional | Ppc traffic sources value used by this API operation. |
data.productCategory | any | optional | Product category value used by this API operation. |
data.productFeatures | any | optional | Product features value used by this API operation. |
data.productImageUrl | any | optional | Product image url value used by this API operation. |
data.productPrice | any | optional | Product price value used by this API operation. |
data.productRatingScore | any | optional | Product rating score value used by this API operation. |
data.productStarRating | any | optional | Product star rating value used by this API operation. |
data.productTitle | any | optional | Product title value used by this API operation. |
data.promotionalDealSources | any | optional | Promotional deal sources value used by this API operation. |
data.recentMonthlySalesBucket | any | optional | Recent monthly sales bucket value used by this API operation. |
data.recommendAdExposureScore | any | optional | Recommend ad exposure score value used by this API operation. |
data.recommendAdKeywordCount | any | optional | Recommend ad keyword count value used by this API operation. |
data.recommendKeywordCount | any | optional | Recommend keyword count value used by this API operation. |
data.recommendNonadExposureScore | any | optional | Recommend nonad exposure score value used by this API operation. |
data.recommendNonadKeywordCount | any | optional | Recommend nonad keyword count value used by this API operation. |
data.recommendPositionExposureScore | any | optional | Recommend position exposure score 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.sponsoredProductsExposureRatio | any | optional | Sponsored products exposure ratio value used by this API operation. |
data.sponsoredProductsExposureScore | any | optional | Sponsored products exposure score value used by this API operation. |
data.sponsoredProductsExposureScorePrev | any | optional | Sponsored products exposure score prev value used by this API operation. |
data.sponsoredProductsKeywordCount | any | optional | Sponsored products keyword count value used by this API operation. |
data.title | any | optional | Title value used by this API operation. |
data.topBrandAdKeywordCount | any | optional | Top brand ad keyword count value used by this API operation. |
data.topRatedExposureRatio | any | optional | Top rated exposure ratio value used by this API operation. |
data.topRatedExposureScore | any | optional | Top rated exposure score value used by this API operation. |
data.topRatedKeywordCount | any | optional | Top rated keyword count value used by this API operation. |
data.total | any | optional | Total value used by this API operation. |
data.totalExposureScore | any | optional | Total exposure score value used by this API operation. |
data.totalExposureScorePrev | any | optional | Total exposure score prev value used by this API operation. |
data.totalPage | any | optional | Total page value used by this API operation. |
data.totalTrafficKeywordCount | any | optional | Total traffic keyword count value used by this API operation. |
data.totalTrafficKeywordCountIn | any | optional | Total traffic keyword count in value used by this API operation. |
data.totalTrafficKeywordCountOut | any | optional | Total traffic keyword count out value used by this API operation. |
data.totalTrafficKeywordCountPrev | any | optional | Total traffic keyword count prev value used by this API operation. |
data.type | any | optional | Type value used by this API operation. |
data.variantsNum | any | optional | Variants num value used by this API operation. |
data.videoAdExposureRatio | any | optional | Video ad exposure ratio value used by this API operation. |
data.videoAdExposureScore | any | optional | Video ad exposure score value used by this API operation. |
data.videoAdExposureScorePrev | any | optional | Video ad exposure score prev value used by this API operation. |
data.videoAdKeywordCount | any | optional | Video ad keyword count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonRecommendationSources | array | optional | Amazon Recommended Source Mark Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonRecommendationSources | null | optional | Amazon recommendation sources value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonsChoiceExposureRatio | number | optional | Amazon's Choice impression share Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonsChoiceExposureRatio | null | optional | Amazons choice exposure ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonsChoiceExposureScore | number | optional | Amazon's Choice Impression Total Score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonsChoiceExposureScore | null | optional | Amazons choice exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonsChoiceExposureScorePrev | number | optional | Last cycle AC exposure score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonsChoiceExposureScorePrev | null | optional | Amazons choice exposure score prev value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonsChoiceKeywordCount | integer | optional | AC keyword count Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonsChoiceKeywordCount | null | optional | Amazons choice keyword count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonsChoiceKeywordCountIn | integer | optional | Number of new AC keywords in this cycle Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonsChoiceKeywordCountIn | null | optional | Amazons choice keyword count in value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonsChoiceKeywordCountOut | integer | optional | Number of AC keywords exiting this cycle Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.amazonsChoiceKeywordCountOut | null | optional | Amazons choice keyword count out value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.asin | string | optional | ASIN code 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.bottomBrandAdKeywordCount | integer | optional | Number of keywords for brand ads at the bottom Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.bottomBrandAdKeywordCount | null | optional | Bottom brand ad keyword count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.brandAdExposureRatio | number | optional | Brand advertising exposure proportion Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.brandAdExposureRatio | null | optional | Brand ad exposure ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.brandAdExposureScore | number | optional | Total brand advertising exposure score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.brandAdExposureScore | null | optional | Brand ad exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.brandAdExposureScorePrev | number | optional | Brand advertising exposure score last cycle Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.brandAdExposureScorePrev | null | optional | Brand ad exposure score prev value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.brandAdKeywordCount | integer | optional | Number of brand advertising keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.brandAdKeywordCount | null | optional | Brand ad keyword 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.customerRatingCount | integer | optional | Total customer ratings Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.customerRatingCount | null | optional | Customer rating count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.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) 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.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.editorialRecommendationsExposureRatio | number | optional | ER exposure ratio Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.editorialRecommendationsExposureRatio | null | optional | Editorial recommendations exposure ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.editorialRecommendationsExposureScore | number | optional | ER total exposure score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.editorialRecommendationsExposureScore | null | optional | Editorial recommendations exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.editorialRecommendationsKeywordCount | integer | optional | ER keyword count Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.editorialRecommendationsKeywordCount | null | optional | Editorial recommendations keyword count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.frequentlyBoughtKeywordCount | integer | optional | Number of recommended keywords for high-frequency purchases Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.frequentlyBoughtKeywordCount | null | optional | Frequently bought keyword count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isMonitored | boolean | optional | Has it been monitored? Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isMonitored | null | optional | Is monitored value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isParentAsin | boolean | optional | Whether the search object is a parent ASIN Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isParentAsin | null | optional | Is parent asin value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isVariantProduct | boolean | optional | Is it a variant? Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isVariantProduct | null | optional | Is variant product value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.monitoringStartTime | string | optional | attention time Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.monitoringStartTime | null | optional | Monitoring start time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchExposureRatio | number | optional | Natural search exposure ratio Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchExposureRatio | null | optional | Natural search exposure ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchExposureScore | number | optional | Total organic search exposure score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchExposureScore | null | optional | Natural search exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchExposureScorePrev | number | optional | Natural search exposure score last cycle Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchExposureScorePrev | null | optional | Natural search exposure score prev value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchKeywordCount | integer | optional | Number of natural search keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchKeywordCount | null | optional | Natural search keyword count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchKeywordCountIn | integer | optional | Number of new natural keywords this cycle Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchKeywordCountIn | null | optional | Natural search keyword count in value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchKeywordCountOut | integer | optional | Number of natural keywords exiting this cycle Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchKeywordCountOut | null | optional | Natural search keyword count out value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchKeywordCountPrev | integer | optional | Number of natural keywords in the previous cycle Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchKeywordCountPrev | null | optional | Natural search keyword count prev value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchTrafficSources | array | optional | Organic search traffic source tag Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.naturalSearchTrafficSources | null | optional | Natural search traffic sources value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.noKeywordVariantsNum | integer | optional | Number of variations without keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.noKeywordVariantsNum | null | optional | No keyword variants num value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nonAcRecommendExposureScore | number | optional | Non-AC recommended position exposure score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nonAcRecommendExposureScore | null | optional | Non ac recommend exposure score 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.ppcTrafficSources | array | optional | PPC Traffic Source Tags Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.ppcTrafficSources | null | optional | Ppc traffic sources value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.productCategory | string | optional | Product category Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productCategory | null | optional | Product category value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.productFeatures | array | optional | Product feature list Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productFeatures | null | optional | Product features value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.productImageUrl | string | optional | Main image URL Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productImageUrl | null | optional | Product image url value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.productPrice | number | optional | Product selling price Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productPrice | null | optional | Product price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.productRatingScore | number | optional | Product rating value (0–5) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productRatingScore | null | optional | Product rating score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.productStarRating | number | optional | Product star rating (0–5) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productStarRating | null | optional | Product star rating value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.productTitle | string | optional | Product title Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productTitle | null | optional | Product title value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.promotionalDealSources | array | optional | Promotion source tag Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.promotionalDealSources | null | optional | Promotional deal sources value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.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+"` Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.recentMonthlySalesBucket | null | optional | Recent monthly sales bucket value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendAdExposureScore | number | optional | Recommended advertising exposure score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendAdExposureScore | null | optional | Recommend ad exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendAdKeywordCount | integer | optional | Number of recommended advertising keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendAdKeywordCount | null | optional | Recommend ad keyword count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendKeywordCount | integer | optional | Total number of recommended keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendKeywordCount | null | optional | Recommend keyword count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendNonadExposureScore | number | optional | Recommended position non-advertising exposure score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendNonadExposureScore | null | optional | Recommend nonad exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendNonadKeywordCount | integer | optional | Number of recommended non-advertising keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendNonadKeywordCount | null | optional | Recommend nonad keyword count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendPositionExposureScore | number | optional | Recommended position exposure total score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendPositionExposureScore | null | optional | Recommend position exposure score 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.sponsoredProductsExposureRatio | number | optional | SP advertising exposure ratio Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredProductsExposureRatio | null | optional | Sponsored products exposure ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredProductsExposureScore | number | optional | SP ad impression total score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredProductsExposureScore | null | optional | Sponsored products exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredProductsExposureScorePrev | number | optional | Last cycle SP exposure score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredProductsExposureScorePrev | null | optional | Sponsored products exposure score prev value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredProductsKeywordCount | integer | optional | SP number of advertising keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredProductsKeywordCount | null | optional | Sponsored products keyword count 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.topBrandAdKeywordCount | integer | optional | Number of top brand ad keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.topBrandAdKeywordCount | null | optional | Top brand ad keyword count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.topRatedExposureRatio | number | optional | TR recommended exposure ratio Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.topRatedExposureRatio | null | optional | Top rated exposure ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.topRatedExposureScore | number | optional | TR Recommended exposure total score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.topRatedExposureScore | null | optional | Top rated exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.topRatedKeywordCount | integer | optional | TR keyword count Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.topRatedKeywordCount | null | optional | Top rated keyword count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.total | integer | optional | The actual amount of data returned this time 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.totalExposureScore | number | optional | Total exposure score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalExposureScore | null | optional | Total exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalExposureScorePrev | number | optional | Total exposure score last cycle Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalExposureScorePrev | null | optional | Total exposure score prev 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.totalTrafficKeywordCount | integer | optional | Total number of traffic keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalTrafficKeywordCount | null | optional | Total traffic keyword count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalTrafficKeywordCountIn | integer | optional | Number of new traffic keywords this cycle Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalTrafficKeywordCountIn | null | optional | Total traffic keyword count in value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalTrafficKeywordCountOut | integer | optional | Number of exit traffic keywords this cycle Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalTrafficKeywordCountOut | null | optional | Total traffic keyword count out value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalTrafficKeywordCountPrev | integer | optional | Total number of traffic keywords in the last cycle Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalTrafficKeywordCountPrev | null | optional | Total traffic keyword count prev 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.variantsNum | integer | optional | Number of variations with keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.variantsNum | null | optional | Variants num value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.videoAdExposureRatio | number | optional | Video ad exposure ratio Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.videoAdExposureRatio | null | optional | Video ad exposure ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.videoAdExposureScore | number | optional | Total video ad exposure score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.videoAdExposureScore | null | optional | Video ad exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.videoAdExposureScorePrev | number | optional | Video ad exposure score last cycle Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.videoAdExposureScorePrev | null | optional | Video ad exposure score prev value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.videoAdKeywordCount | integer | optional | Number of video ad keywords Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.videoAdKeywordCount | null | optional | Video ad keyword 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.