https://api.nexscope.ai/sf/keywordSummaryRun 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/keywordSummary |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
searchKeyword | string | required | Search keywords, maximum length 1000; try to use the target site language |
country | string | optional | Site: `US`, `UK`, `DE`, `CA`, `JP`, `FR`, `ES`, `IT`, `MX`, `AU`, `AE`, `BR`, `SA` Example: US |
asins | string | optional | ASIN filter list, comma separated; maximum length 1000 |
condition | string | optional | Only one condition can be passed at a time: `nfPosition`, `isSpAd`, `isVedioAd`, `isBrandAd`, `isPPCAd`, `isSearchRecommend`、`acAd`、`totalPeriod.in`、`nfKeywordCnt.total`/`.in`、`adKeywordCnt.total`/`.in`、`allSpKeywordCnt.total`/`.in`、`spKeywordCnt.total`/`.in`、`recSpKeywordCnt.total`/`.in`, `allSbKeywordCnt.total`/`.in`, `sbKeywordCnt.total`/`.in`, `sbvKeywordCnt.total`/`.in` |
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` |
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–100 Example: 100 |
desc | boolean | optional | Is descending order Example: true |
Code example
{
"asins": "B01NBNDC1T,B09VLJJPL6",
"country": "US",
"pageSize": 50,
"searchKeyword": "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.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.asin | any | optional | Asin 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.columns | any | optional | Columns value used by this API operation. |
data.comprehensiveNaturalExposureRatio | any | optional | Comprehensive natural exposure ratio value used by this API operation. |
data.comprehensiveNaturalExposureScore | any | optional | Comprehensive natural exposure score 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.keywordAmazonsChoiceExposureScore | any | optional | Keyword amazons choice exposure score value used by this API operation. |
data.keywordBrandAdExposureScore | any | optional | Keyword brand ad exposure score value used by this API operation. |
data.keywordComprehensiveNaturalExposureScore | any | optional | Keyword comprehensive natural exposure score value used by this API operation. |
data.keywordNaturalExposureScore | any | optional | Keyword natural exposure score value used by this API operation. |
data.keywordRecommendAdExposureScore | any | optional | Keyword recommend ad exposure score value used by this API operation. |
data.keywordRecommendExposureScore | any | optional | Keyword recommend exposure score value used by this API operation. |
data.keywordRecommendNonadExposureScore | any | optional | Keyword recommend nonad exposure score value used by this API operation. |
data.keywordSponsoredProductsExposureScore | any | optional | Keyword sponsored products exposure score value used by this API operation. |
data.keywordTotalExposureScore | any | optional | Keyword total exposure score value used by this API operation. |
data.keywordVideoAdExposureScore | any | optional | Keyword video ad exposure score 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.naturalSearchTrafficSources | any | optional | Natural search traffic sources 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.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.productUpdateTime | any | optional | Product update time value used by this API operation. |
data.promotionalDealSources | any | optional | Promotional deal sources value used by this API operation. |
data.recommendAdExposureRatio | any | optional | Recommend ad exposure ratio value used by this API operation. |
data.recommendAdExposureScore | any | optional | Recommend ad exposure score value used by this API operation. |
data.recommendNonadExposureRatio | any | optional | Recommend nonad exposure ratio value used by this API operation. |
data.recommendNonadExposureScore | any | optional | Recommend nonad exposure score 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.title | any | optional | Title 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.total | any | optional | Total value used by this API operation. |
data.totalExposureRatio | any | optional | Total exposure ratio value used by this API operation. |
data.totalExposureScore | any | optional | Total exposure score value used by this API operation. |
data.totalPage | any | optional | Total page value used by this API operation. |
data.type | any | optional | Type 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. |
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 | AC exposure ratio 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 | AC exposure 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.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.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.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.comprehensiveNaturalExposureRatio | number | optional | Combined organic traffic share Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.comprehensiveNaturalExposureRatio | null | optional | Comprehensive natural exposure ratio value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.comprehensiveNaturalExposureScore | number | optional | Comprehensive organic traffic score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.comprehensiveNaturalExposureScore | null | optional | Comprehensive natural exposure score 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 keyword traffic data 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.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.keywordAmazonsChoiceExposureScore | number | optional | AC score of this keyword Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordAmazonsChoiceExposureScore | null | optional | Keyword amazons choice exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordBrandAdExposureScore | number | optional | Brand advertising score for this keyword Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordBrandAdExposureScore | null | optional | Keyword brand ad exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordComprehensiveNaturalExposureScore | number | optional | Comprehensive natural score for this keyword Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordComprehensiveNaturalExposureScore | null | optional | Keyword comprehensive natural exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordNaturalExposureScore | number | optional | Natural score for this keyword Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordNaturalExposureScore | null | optional | Keyword natural exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordRecommendAdExposureScore | number | optional | Advertising score for recommended positions for this keyword Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordRecommendAdExposureScore | null | optional | Keyword recommend ad exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordRecommendExposureScore | number | optional | Recommended position score for this keyword Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordRecommendExposureScore | null | optional | Keyword recommend exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordRecommendNonadExposureScore | number | optional | This keyword recommendation position is not an advertising score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordRecommendNonadExposureScore | null | optional | Keyword recommend nonad exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordSponsoredProductsExposureScore | number | optional | SP score of this keyword Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordSponsoredProductsExposureScore | null | optional | Keyword sponsored products exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordTotalExposureScore | number | optional | The total score of this keyword Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordTotalExposureScore | null | optional | Keyword total exposure score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordVideoAdExposureScore | number | optional | Video ad score for this keyword Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keywordVideoAdExposureScore | null | optional | Keyword video ad exposure score 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.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.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.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 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 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.productUpdateTime | string | optional | Product update time Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productUpdateTime | null | optional | Product update time 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.recommendAdExposureRatio | number | optional | Recommended advertising traffic share Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendAdExposureRatio | null | optional | Recommend ad exposure ratio 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.recommendNonadExposureRatio | number | optional | Recommended non-advertising traffic share Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.recommendNonadExposureRatio | null | optional | Recommend nonad exposure ratio 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.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.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.topRatedExposureRatio | number | optional | TR 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 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.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.totalExposureRatio | number | optional | Total traffic share Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalExposureRatio | null | optional | Total exposure ratio 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.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.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.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 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.