https://api.nexscope.ai/amazonAds/reporting/reports/by-reportIdRun 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/by-reportId |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
connectionId | integer | required | An Amazon Ads connection owned by the authenticated Nexscope user. |
reportId | string | required | Report ID created; creation skipped after passed in. |
name | string | optional | Report display name. |
timeUnit | string | optional | `DAILY` or `SUMMARY`. Example: SUMMARY |
format | string | optional | Report file format. Example: GZIP_JSON |
filters | array | optional | Field and value enumerations are based on the corresponding report-type file. |
pollInterval | integer | optional | Polling interval in seconds. Example: 30 |
maxAttempts | integer | optional | Maximum number of polls, default waiting window of approximately 10 minutes. Example: 20 |
skipDepCheck | boolean | optional | Skip dependency checking. Example: false |
serveExtractedFileHttp | boolean | optional | Whether to start the native temporary HTTP service. Example: true |
serveHost | string | optional | Native service binding address. |
servePort | integer | optional | 0 indicates the system allocated port. Example: 0 |
serveSeconds | integer | optional | The number of seconds the local link remains alive. Example: 300 |
includeAmazonSourceUrl | boolean | optional | Whether to return the Amazon presigned source URL. Example: false |
confirmationToken | string | optional | For mutations, first preview without a token, then confirm using the returned single-use token. |
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 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.