https://api.nexscope.ai/amazonAds/reporting/reportsRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/amazonAds/reporting/reports |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
adProduct | string | required | Contrast report-type frontmatter, such as `SPONSORED_PRODUCTS`, `SPONSORED_BRANDS`, `SPONSORED_DISPLAY`. |
columns | array | required | Check against a subset of allowed columns of the corresponding Base metrics table. |
columns[] | object | required | Check against a subset of allowed columns of the corresponding Base metrics table. |
confirmationToken | string | optional | For mutations, first preview without a token, then confirm using the returned single-use token. |
connectionId | integer | required | An Amazon Ads connection owned by the authenticated Nexscope user. |
endDate | string | required | `YYYY-MM-DD`, including the current day. |
filters | array | optional | Field and value enumerations are based on the corresponding report-type file. |
filters[] | object | required | Field and value enumerations are based on the corresponding report-type file. |
format | string | optional | Report file format. Default: GZIP_JSON |
groupBy | array | required | Compare report-type frontmatter; no guesswork required. |
groupBy[] | object | required | Compare report-type frontmatter; no guesswork required. |
includeAmazonSourceUrl | boolean | optional | Whether to return the Amazon presigned source URL. Default: false |
maxAttempts | integer | optional | Maximum number of polls, default waiting window of approximately 10 minutes. Default: 20 |
name | string | optional | Report display name. |
pollInterval | integer | optional | Polling interval in seconds. Default: 30 |
reportTypeId | string | required | Check the corresponding report-types file. |
serveExtractedFileHttp | boolean | optional | Whether to start the native temporary HTTP service. Default: true |
serveHost | string | optional | Native service binding address. |
servePort | integer | optional | 0 indicates the system allocated port. Default: 0 |
serveSeconds | integer | optional | The number of seconds the local link remains alive. Default: 300 |
skipDepCheck | boolean | optional | Skip dependency checking. Default: false |
startDate | string | required | `YYYY-MM-DD`, including the current day. |
timeUnit | string | optional | `DAILY` or `SUMMARY`. Default: SUMMARY |
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 (12 fields)
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | optional | Whether downloaded and decompressed successfully. |
reportId | string | optional | Amazon reporting ID. |
status | string | optional | `PENDING`, `PROCESSING`, `COMPLETED` or `FAILED`. |
reportTypeId | string | optional | The type of report requested. |
pollAttempts | integer | optional | Number of times polled. |
elapsedSeconds | number | optional | The number of seconds elapsed. |
downloadPath | string | optional | The downloaded or decompressed local file path. |
extractedFileHttpUrl | string | optional | Native temporary file URL (if enabled). |
serveExpiresAt | string | optional | Native URL expiration time (if returned). |
failureReason | string | optional | Reason for upstream failure when `FAILED`. |
resumeHint.mode | string | optional | `poll-only`γ |
resumeHint.params | object | optional | Reuse the same reportId and increase maxAttempts to continue polling. |
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 or invalid API key (code 11209, including an incomplete or corrupted copy) or an expired website login session (code 12001), 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.