POST
https://api.nexscope.ai/amazonAds/adsApi/v1/retrieve/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/adsApi/v1/retrieve/reports |
| 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. |
Code example
{
"body": "{}",
"contentType": "application/json",
"method": "POST"
}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
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 | HTTP request completed. Check JSON code; only 0 indicates business success or acceptance. |
| 400 | Request JSON or required API parameters are invalid. |
| 401 | API key is missing, invalid, or cannot be matched to a user. |
| 5xx | API execution or upstream service failed. |
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.