Amazon Advertising

Amazon Ads Reporting

Uses the source get_report contract: omit reportId to create, supply reportId to poll, or supply a backend documentToken to download.

post/api/skill-api/v1/skills/amazon-ads-reporting/run

Request

  • Base URL: https://api.nexscope.ai
  • URL: https://api.nexscope.ai/api/skill-api/v1/skills/amazon-ads-reporting/run
  • Auth: HTTP bearer

Headers

X-Nexscope-Http-Status'legacy' | 'semantic'

Use semantic for HTTP error statuses on run and task-result requests. Without this header v1 retains legacy status behavior. The JSON envelope is unchanged; code 0 means success or acceptance, not asynchronous completion.

Request body

connectionIdinteger required

Owned Amazon Ads connection ID.

reportIdstring

Existing report ID; when present the API polls that report.

reportTypeIdstring

Report type required by a new report unless configuration supplies it.

adProductstring

Ad product required by a new report unless configuration supplies it.

groupBystring[]

Report grouping fields.

columnsstring[]

Requested report columns.

namestring

Optional report name.

startDatestring

Inclusive report start date for a new report.

endDatestring

Inclusive report end date for a new report.

timeUnitstring

Optional report time unit.

formatstring

Optional report format.

configurationobject

Complete Amazon Ads reporting configuration; may replace reportTypeId/adProduct/groupBy/columns.

documentTokenstring

Backend-issued token for downloading a completed report.

Example request

{
  "startDate": "2026-07-01",
  "reportTypeId": "spCampaigns",
  "adProduct": "SPONSORED_PRODUCTS",
  "connectionId": 123,
  "groupBy": [
    "campaign"
  ],
  "endDate": "2026-07-31",
  "columns": [
    "campaignId",
    "impressions"
  ]
}

Response

Successful response.

codeinteger required

0 means accepted or successful; nonzero is a platform error.

msgstring nullable required
tsstring required

Epoch milliseconds.

timestring required

Server local time: yyyy-MM-dd HH:mm:ss.

coststring required

Elapsed milliseconds, never credits; -1 outside web requests.

traceIdstring nullable required

Example response

{
  "data": {
    "status": "PENDING",
    "reportId": "report-id",
    "documentToken": "opaque-document-token",
    "contentType": "application/json"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.