https://api.nexscope.ai/aba/intelligentQueryRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/aba/intelligentQuery |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
analysisDescription | string | required | Natural language that accurately describes query intent. |
region | string | optional | Amazon site code. Optional values: `US`, `DE`, `BR`, `CA`, `AU`, `JP`, `AE`, `ES`, `FR`, `IT`, `SA`, `TR`, `MX`, `SE`, `NL`. Example: US |
createDownloadUrl | boolean | optional | Whether to generate a CSV download link; set to `true` when explicitly required to download, export or generate files. Example: false |
Code example
{
"analysisDescription": "Find the search popularity rankings for the keyword gift in the US marketplace over the past 12 weeks.",
"createDownloadUrl": false,
"region": "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.clickShare | any | optional | Click share value used by this API operation. |
data.clickShareRank | any | optional | Click share rank value used by this API operation. |
data.clickedAsin | any | optional | Clicked asin value used by this API operation. |
data.clickedItemName | any | optional | Clicked item name value used by this API operation. |
data.columns | any | optional | Columns value used by this API operation. |
data.conversionShare | any | optional | Conversion share 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.data | any | optional | Data value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.downloadNote | any | optional | Download note value used by this API operation. |
data.downloadUrl | any | optional | Download url value used by this API operation. |
data.name | any | optional | Name 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.region | any | optional | Region value used by this API operation. |
data.reportStartDate | any | optional | Report start date value used by this API operation. |
data.searchFrequencyRank | any | optional | Search frequency rank value used by this API operation. |
data.searchTerm | any | optional | Search term 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.success | any | optional | Success value used by this API operation. |
data.tables | any | optional | Tables value used by this API operation. |
data.title | any | optional | Title value used by this API operation. |
data.total | any | optional | Total 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. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.clickShare | number | optional | The click share received by this ASIN, ranging from 0 to 1. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.clickShare | null | optional | Click share value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.clickShareRank | integer | optional | The click share ranking of this ASIN under this search term. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.clickShareRank | null | optional | Click share rank value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.clickedAsin | string | optional | The ASIN of the clicked product. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.clickedAsin | null | optional | Clicked asin value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.clickedItemName | string | optional | The clicked product name. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.clickedItemName | null | optional | Clicked item name value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | array | optional | Result column definition. 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.conversionShare | number | optional | The conversion share obtained by this ASIN, ranging from 0 to 1. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.conversionShare | null | optional | Conversion share value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | integer | optional | Time taken, in milliseconds. 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 | The token consumed by this call. 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.data | array | optional | Query result data rows. The actual columns will vary depending on the query conditions. 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.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.downloadNote | string | optional | Tips for downloading. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.downloadNote | null | optional | Download note value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.downloadUrl | string | optional | The CSV file address returned when `createDownloadUrl` is `true`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.downloadUrl | null | optional | Download url value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.name | string | optional | Sheet 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.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.region | string | optional | Amazon site code. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.region | null | optional | Region value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.reportStartDate | string | optional | The start date of the data collection week. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.reportStartDate | null | optional | Report start date value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.searchFrequencyRank | integer | optional | Search popularity ranking; the smaller the value, the higher the search popularity, and 1 is the most popular. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.searchFrequencyRank | null | optional | Search frequency rank value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.searchTerm | string | optional | Consumer search keywords. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.searchTerm | null | optional | Search term 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.success | boolean | optional | Whether the query is successful. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.success | null | optional | Success value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.tables | array | optional | Resulting data array; each element contains `data` (data row), `columns` (column definition), and `name` (sheet name). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.tables | null | optional | Tables 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.total | integer | optional | Total number of results. 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.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 | Provider-specific render or payload type. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.type | null | optional | Type 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.