https://claw-callback.nexscope.ai/api/skill-api/v1/skills/amazon-ads-reporting/runRun this API
Send a JSON request to execute this API and receive the direct response payload.
Endpoint
| Method | POST |
| Path | https://claw-callback.nexscope.ai/api/skill-api/v1/skills/amazon-ads-reporting/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
connectionId | integer | required | Owned Amazon Ads connection ID. Example: 123 |
reportId | string | optional | Existing report ID; when present the API polls that report. Example: report-id |
reportTypeId | string | optional | Report type required by a new report unless configuration supplies it. Example: spCampaigns |
adProduct | string | optional | Ad product required by a new report unless configuration supplies it. Example: SPONSORED_PRODUCTS |
groupBy | array | optional | Report grouping fields. Example: [
"campaign"
] |
columns | array | optional | Requested report columns. Example: [
"campaignId",
"impressions",
"clicks"
] |
name | string | optional | Optional report name. Example: Campaign report |
startDate | string | optional | Inclusive report start date for a new report. Example: 2026-07-01 |
endDate | string | optional | Inclusive report end date for a new report. Example: 2026-07-31 |
timeUnit | string | optional | Optional report time unit. Example: DAILY |
format | string | optional | Optional report format. Example: GZIP_JSON |
filters | array | optional | Optional report filters. Example: [] |
configuration | object | optional | Complete Amazon Ads reporting configuration; may replace reportTypeId/adProduct/groupBy/columns. Example: {} |
documentToken | string | optional | Backend-issued token for downloading a completed report. Example: opaque-document-token |
Request example
{
"reportTypeId": "spCampaigns",
"startDate": "2026-07-01",
"columns": [
"campaignId",
"impressions"
],
"endDate": "2026-07-31",
"groupBy": [
"campaign"
],
"connectionId": 123,
"adProduct": "SPONSORED_PRODUCTS"
}Response body
Returns safe report lifecycle results without upstream URLs or credentials.
| Name | Type | Required | Description |
|---|---|---|---|
status | string | optional | Report status. Example: PENDING |
reportId | string | optional | Provider report ID. Example: report-id |
documentToken | string | optional | Safe opaque token used for download. Example: opaque-document-token |
content | object | optional | Downloaded report content when available. Example: {} |
contentType | string | optional | Downloaded report content type. Example: application/json |
errcode | integer | optional | Upstream status code returned by the provider. |
errmsg | string | optional | Upstream status message returned by the provider. |
code | string | optional | Provider-specific status code. |
msg | string | optional | Provider-specific status message. |
message | string | optional | Provider-specific message. |
type | string | optional | Provider-specific render or payload type. |
title | string | optional | Provider-specific response title. |
sourceType | string | optional | Provider-specific source platform type. |
sourceTool | string | optional | Provider-specific source tool name. |
costToken | integer | optional | Token cost reported by the upstream provider. |
costTime | integer | optional | Execution time reported by the upstream provider. |
page | integer | optional | Current page returned by the upstream provider. |
pageSize | integer | optional | Page size returned by the upstream provider. |
pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. |
totalPage | integer | optional | Total page count returned by the upstream provider. |
dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. |
Response example
Direct response payload. No extra wrapper is added.
{
"status": "PENDING",
"reportId": "report-id",
"documentToken": "opaque-document-token",
"content": {},
"contentType": "application/json"
}Responses
| Code | Description |
|---|---|
| 200 | API executed successfully. Body is the direct response payload. |
| 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.