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 |
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 (21 fields)
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | optional | Whether the query is successful. |
tables | array | optional | Resulting data array; each element contains `data` (data row), `columns` (column definition), and `name` (sheet name). |
total | integer | optional | Total number of results. |
downloadUrl | string | optional | The CSV file address returned when `createDownloadUrl` is `true`. |
msg | string | optional | Additional message. |
downloadNote | string | optional | Tips for downloading. |
code | string | optional | Return code. |
costTime | integer | optional | Time taken, in milliseconds. |
costToken | integer | optional | The token consumed by this call. |
data | array | optional | Query result data rows. The actual columns will vary depending on the query conditions. |
columns | array | optional | Result column definition. |
name | string | optional | Sheet name. |
searchTerm | string | optional | Consumer search keywords. |
reportStartDate | string | optional | The start date of the data collection week. |
region | string | optional | Amazon site code. |
searchFrequencyRank | integer | optional | Search popularity ranking; the smaller the value, the higher the search popularity, and 1 is the most popular. |
clickedAsin | string | optional | The ASIN of the clicked product. |
clickedItemName | string | optional | The clicked product name. |
clickShareRank | integer | optional | The click share ranking of this ASIN under this search term. |
clickShare | number | optional | The click share received by this ASIN, ranging from 0 to 1. |
conversionShare | number | optional | The conversion share obtained by this ASIN, ranging from 0 to 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.