https://api.nexscope.ai/amazonAds/developerProxyRun 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/developerProxy |
| 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. |
method | string | required | The three stages of Ads v1 are all `POST`. |
body | string | required | JSON string; account query can be `{}`, report creation/polling see dedicated reference respectively. |
contentType | string | optional | Typically `application/json`. |
pollInterval | integer | optional | 5–300 seconds; official recommendation is to poll every minute. Example: 60 |
maxAttempts | integer | optional | 1–120, default waiting window of approximately 10 minutes. Example: 10 |
reportId | string | optional | After passing in, account mapping and creation will be skipped, and existing reports will only be polled. |
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 (15 fields)
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | optional | Whether the entry script completes report processing. |
status | string | optional | `PENDING`, `PROCESSING`, `COMPLETED`, `FAILED` or `STILL_PROCESSING`. |
reportId | string | optional | Report ID. |
reportKind | string | optional | `audience` or `search-impression-share`. |
profileId | number | optional | Ads profile used. |
advertiserAccountId | string | optional | The Ads v1 account ID mapped to. |
fields | array | optional | The actual fixed field combination (as returned). |
totalRows | integer | optional | The total number of rows after merging; 0 is a legally empty report. |
dataFiles[] | array | optional | Local CSV slice file and row number. |
preview[] | array | optional | Results preview. |
resumeHint | object | optional | Continue parameters during STILL_PROCESSING. |
_cacheable | boolean | optional | Successful results are cached for 24 hours; failed/incomplete is false. |
part | integer | optional | Fragment serial number. |
path | string | optional | Local CSV file path. |
rowCount | integer | optional | The number of rows in this shard. |
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.