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 |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (34 fields)
| Name | Type | Required | Description |
|---|---|---|---|
costToken | integer | optional | Number of tokens consumed |
shareOfVoice | object | optional | Share of Voice data subject |
id | string | optional | Resource ID |
type | string | optional | Fixed value `share_of_voice` |
estimated30DaySearchVolume | integer | optional | Exact match search volume over the past 30 days |
exactSuggestedBidMedian | number | optional | Median PPC bid (USD) |
productCount | integer | optional | Total number of items in the first 3 pages of search results |
updatedAt | string | optional | Data update time |
topAsinsModelStartDate | string | optional | TOP ASIN click/conversion data window start date |
topAsinsModelEndDate | string | optional | TOP ASIN click/conversion data window end date |
brands | array | optional | Brand SOV detailed list |
topAsins | array | optional | TOP 3 ASIN click conversion list |
brand | string | optional | brand name |
organicProducts | integer | optional | Number of items in organic search results |
sponsoredProducts | integer | optional | The number of products in the ad slot |
combinedProducts | integer | optional | Comprehensive product quantity |
organicBasicSov | number | optional | Natural search basics SOV (0–1) |
organicWeightedSov | number | optional | Natural search weighted SOV (0–1) |
sponsoredBasicSov | number | optional | Ad search basics SOV (0–1) |
sponsoredWeightedSov | number | optional | Ad Search Weighted SOV (0–1) |
combinedBasicSov | number | optional | Comprehensive Basic SOV (0–1) |
combinedWeightedSov | number | optional | Comprehensive weighted SOV (0–1) |
organicAveragePosition | number | optional | Average organic search ranking position |
sponsoredAveragePosition | number | optional | Ad search average position |
combinedAveragePosition | number | optional | Overall average ranking position |
organicAveragePrice | number | optional | Average price of natural search items |
sponsoredAveragePrice | number | optional | Average price of advertised search products |
combinedAveragePrice | number | optional | Comprehensive product average price |
asin | string | optional | ASIN number |
name | string | optional | Product name |
brand | string | optional | brand name |
clicks | integer | optional | Clicks (30-day window) |
conversions | integer | optional | Conversions (30-day window) |
conversionRate | number | optional | Conversion rate (0-1) |
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.