POST
https://api.nexscope.ai/api/skill-api/v1/skills/amazon-keyword-share-of-voice/runRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/api/skill-api/v1/skills/amazon-keyword-share-of-voice/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
marketplace | string | required | Target marketplace code. Options: us, uk, de, in, ca, fr, it, es, mx, jp Example: us |
keyword | string | required | Keyword to query Example: phone case |
Request example
{
"keyword": "phone case",
"marketplace": "us"
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | any | required | Data value used by this API operation. |
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
msg | string | null | required | Msg value used by this API operation. |
ts | string | required | Epoch milliseconds. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
traceId | string | null | required | Trace id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.costToken | integer | optional | Tokens consumed Example: 1 |
data.shareOfVoice | object | optional | Share of Voice data body Example: {} |
data.id | string | optional | Resource identifier Example: example-id |
data.type | string | optional | Fixed value share_of_voice Example: null |
data.estimated30DaySearchVolume | integer | optional | Exact match search volume over the past 30 days Example: 1 |
data.exactSuggestedBidMedian | number | optional | PPC bid median (USD) Example: 1 |
data.productCount | integer | optional | Total product count in the first 3 pages of search results Example: 1 |
data.updatedAt | string | optional | Data update time Example: 2026-01-01 |
data.topAsinsModelStartDate | string | optional | TOP ASIN click/conversion data window start date Example: B072MQ5BRX |
data.topAsinsModelEndDate | string | optional | TOP ASIN click/conversion data window end date Example: B072MQ5BRX |
data.brands | array | optional | Brand SOV detail list Example: [] |
data.topAsins | array | optional | TOP 3 ASIN click and conversion list Example: [] |
data.brands[].brand | string | optional | Brand name Example: null |
data.brands[].organicProducts | integer | optional | Number of products in organic search results Example: 1 |
data.brands[].sponsoredProducts | integer | optional | Number of products in ad placements Example: 1 |
data.brands[].combinedProducts | integer | optional | Combined product count Example: 1 |
data.brands[].organicBasicSov | number | optional | Organic basic SOV (0-1) Example: 1 |
data.brands[].organicWeightedSov | number | optional | Organic weighted SOV (0-1) Example: 1 |
data.brands[].sponsoredBasicSov | number | optional | Sponsored basic SOV (0-1) Example: 1 |
data.brands[].sponsoredWeightedSov | number | optional | Sponsored weighted SOV (0-1) Example: 1 |
data.brands[].combinedBasicSov | number | optional | Combined basic SOV (0-1) Example: 1 |
data.brands[].combinedWeightedSov | number | optional | Combined weighted SOV (0-1) Example: 1 |
data.brands[].organicAveragePosition | number | optional | Average organic search rank position Example: 1 |
data.brands[].sponsoredAveragePosition | number | optional | Average sponsored search rank position Example: 1 |
data.brands[].combinedAveragePosition | number | optional | Combined average rank position Example: 1 |
data.brands[].organicAveragePrice | number | optional | Average organic search product price Example: 1 |
data.brands[].sponsoredAveragePrice | number | optional | Average sponsored search product price Example: 1 |
data.brands[].combinedAveragePrice | number | optional | Combined average product price Example: 1 |
data.topAsins[].asin | string | optional | ASIN number Example: B072MQ5BRX |
data.topAsins[].name | string | optional | Product name Example: null |
data.topAsins[].brand | string | optional | Brand name Example: null |
data.topAsins[].clicks | integer | optional | Click volume (30-day window) Example: 1 |
data.topAsins[].conversions | integer | optional | Conversion volume (30-day window) Example: 1 |
data.topAsins[].conversionRate | number | optional | Conversion rate (0-1) Example: 1 |
data.title | string | optional | Provider-specific response title. Example: null |
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"data": {
"costToken": 1,
"shareOfVoice": {},
"id": "example-id",
"estimated30DaySearchVolume": 1,
"exactSuggestedBidMedian": 1,
"productCount": 1,
"updatedAt": "2026-01-01",
"topAsinsModelStartDate": "B072MQ5BRX",
"topAsinsModelEndDate": "B072MQ5BRX",
"brands": [
{
"organicProducts": 1,
"sponsoredProducts": 1,
"combinedProducts": 1,
"organicBasicSov": 1,
"organicWeightedSov": 1,
"sponsoredBasicSov": 1,
"sponsoredWeightedSov": 1,
"combinedBasicSov": 1,
"combinedWeightedSov": 1,
"organicAveragePosition": 1,
"sponsoredAveragePosition": 1,
"combinedAveragePosition": 1,
"organicAveragePrice": 1,
"sponsoredAveragePrice": 1,
"combinedAveragePrice": 1
}
],
"topAsins": [
{
"asin": "B072MQ5BRX",
"clicks": 1,
"conversions": 1,
"conversionRate": 1
}
]
},
"code": 0,
"msg": null,
"ts": "0",
"time": "2026-01-01 00:00:00",
"cost": "-1",
"traceId": null
}Responses
| Code | Description |
|---|---|
| 200 | HTTP request completed. Check JSON code; only 0 indicates business success or acceptance. |
| 400 | Request JSON or required API parameters are invalid. |
| 401 | API key is missing, invalid, or cannot be matched to a user. |
| 5xx | API execution or upstream service failed. |
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.