https://api.nexscope.ai/js/keywords/share-of-voiceRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/js/keywords/share-of-voice |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
marketplace | string | required | Target market code. Optional values: `us`, `uk`, `de`, `in`, `ca`, `fr`, `it`, `es`, `mx`, `jp` Example: us |
keyword | string | required | Keywords to be searched |
Code example
{
"keyword": "portable charger",
"marketplace": "us"
}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.asin | any | optional | Asin value used by this API operation. |
data.brand | any | optional | Brand value used by this API operation. |
data.brands | any | optional | Brands value used by this API operation. |
data.clicks | any | optional | Clicks value used by this API operation. |
data.combinedAveragePosition | any | optional | Combined average position value used by this API operation. |
data.combinedAveragePrice | any | optional | Combined average price value used by this API operation. |
data.combinedBasicSov | any | optional | Combined basic sov value used by this API operation. |
data.combinedProducts | any | optional | Combined products value used by this API operation. |
data.combinedWeightedSov | any | optional | Combined weighted sov value used by this API operation. |
data.conversionRate | any | optional | Conversion rate value used by this API operation. |
data.conversions | any | optional | Conversions 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.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.estimated30DaySearchVolume | any | optional | Estimated30 day search volume value used by this API operation. |
data.exactSuggestedBidMedian | any | optional | Exact suggested bid median value used by this API operation. |
data.id | any | optional | Id value used by this API operation. |
data.name | any | optional | Name value used by this API operation. |
data.organicAveragePosition | any | optional | Organic average position value used by this API operation. |
data.organicAveragePrice | any | optional | Organic average price value used by this API operation. |
data.organicBasicSov | any | optional | Organic basic sov value used by this API operation. |
data.organicProducts | any | optional | Organic products value used by this API operation. |
data.organicWeightedSov | any | optional | Organic weighted sov 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.productCount | any | optional | Product count value used by this API operation. |
data.shareOfVoice | any | optional | Share of voice 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.sponsoredAveragePosition | any | optional | Sponsored average position value used by this API operation. |
data.sponsoredAveragePrice | any | optional | Sponsored average price value used by this API operation. |
data.sponsoredBasicSov | any | optional | Sponsored basic sov value used by this API operation. |
data.sponsoredProducts | any | optional | Sponsored products value used by this API operation. |
data.sponsoredWeightedSov | any | optional | Sponsored weighted sov value used by this API operation. |
data.title | any | optional | Title value used by this API operation. |
data.topAsins | any | optional | Top asins value used by this API operation. |
data.topAsinsModelEndDate | any | optional | Top asins model end date value used by this API operation. |
data.topAsinsModelStartDate | any | optional | Top asins model start date 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.updatedAt | any | optional | Updated at value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.asin | string | optional | ASIN number 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.brand | any | optional | Brand value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.brand | string | optional | brand name Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.brand | null | optional | Brand value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.brand | null | optional | Brand value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.brands | array | optional | Brand SOV detailed list Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.brands | null | optional | Brands value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.clicks | integer | optional | Clicks (30-day window) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.clicks | null | optional | Clicks value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.combinedAveragePosition | number | optional | Overall average ranking position Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.combinedAveragePosition | null | optional | Combined average position value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.combinedAveragePrice | number | optional | Comprehensive product average price Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.combinedAveragePrice | null | optional | Combined average price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.combinedBasicSov | number | optional | Comprehensive Basic SOV (0–1) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.combinedBasicSov | null | optional | Combined basic sov value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.combinedProducts | integer | optional | Comprehensive product quantity Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.combinedProducts | null | optional | Combined products value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.combinedWeightedSov | number | optional | Comprehensive weighted SOV (0–1) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.combinedWeightedSov | null | optional | Combined weighted sov value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.conversionRate | number | optional | Conversion rate (0-1) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.conversionRate | null | optional | Conversion rate value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.conversions | integer | optional | Conversions (30-day window) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.conversions | null | optional | Conversions value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | integer | optional | Execution time reported by the upstream provider. 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 | Number of tokens consumed 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.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.estimated30DaySearchVolume | integer | optional | Exact match search volume over the past 30 days Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.estimated30DaySearchVolume | null | optional | Estimated30 day search volume value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.exactSuggestedBidMedian | number | optional | Median PPC bid (USD) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.exactSuggestedBidMedian | null | optional | Exact suggested bid median value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.id | string | optional | Resource ID Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.id | null | optional | Id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.name | string | optional | Product name Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.name | null | optional | Name value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.organicAveragePosition | number | optional | Average organic search ranking position Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.organicAveragePosition | null | optional | Organic average position value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.organicAveragePrice | number | optional | Average price of natural search items Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.organicAveragePrice | null | optional | Organic average price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.organicBasicSov | number | optional | Natural search basics SOV (0–1) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.organicBasicSov | null | optional | Organic basic sov value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.organicProducts | integer | optional | Number of items in organic search results Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.organicProducts | null | optional | Organic products value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.organicWeightedSov | number | optional | Natural search weighted SOV (0–1) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.organicWeightedSov | null | optional | Organic weighted sov 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.productCount | integer | optional | Total number of items in the first 3 pages of search results Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productCount | null | optional | Product count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.shareOfVoice | object | optional | Share of Voice data subject Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.shareOfVoice | null | optional | Share of voice 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.sponsoredAveragePosition | number | optional | Ad search average position Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredAveragePosition | null | optional | Sponsored average position value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredAveragePrice | number | optional | Average price of advertised search products Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredAveragePrice | null | optional | Sponsored average price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredBasicSov | number | optional | Ad search basics SOV (0–1) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredBasicSov | null | optional | Sponsored basic sov value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredProducts | integer | optional | The number of products in the ad slot Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredProducts | null | optional | Sponsored products value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredWeightedSov | number | optional | Ad Search Weighted SOV (0–1) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sponsoredWeightedSov | null | optional | Sponsored weighted sov value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.title | string | optional | Provider-specific response 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.topAsins | array | optional | TOP 3 ASIN click conversion list Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.topAsins | null | optional | Top asins value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.topAsinsModelEndDate | string | optional | TOP ASIN click/conversion data window end date Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.topAsinsModelEndDate | null | optional | Top asins model end date value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.topAsinsModelStartDate | string | optional | TOP ASIN click/conversion data window start date Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.topAsinsModelStartDate | null | optional | Top asins model start date 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 | Fixed value `share_of_voice` 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.updatedAt | string | optional | Data update time Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.updatedAt | null | optional | Updated at 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.