v1

List PPC campaigns with placement performance

Returns a paginated list of Sponsored Products campaigns for the specified seller account and marketplace, each with totals for the reporting window (impressions, clicks, spend, sales, units, orders, CTR, CPC, ACOS, ROAS) and, by default, a per-placement breakdown with that placement bid adjustment. Optionally narrow to the campaigns advertising one ASIN (asin) or one variation family (parentAsin).

The reporting window defaults to the last 30 days and cannot exceed 90 days.

Rate limited to approximately 60 requests per minute per API key.

get/v1/sellers/{sellerId}/marketplaces/{marketplace}/ppc/campaigns

Path parameters

marketplacestring required
Example:com

Amazon marketplace code (e.g. com, co.uk, de, ca)

sellerIdstring required
Example:A1B2C3D4E5

Amazon seller account identifier (amzSellerId) connected to DataDive

Query parameters

startDatestring
Example:2024-06-01T00:00:00Z

Start of the reporting window (ISO 8601). Defaults to 30 days before endDate.

endDatestring
Example:2024-07-01T00:00:00Z

End of the reporting window (ISO 8601). Defaults to now.

asinstring
Example:B0ABCDEFGH

Only campaigns advertising this ASIN. Cannot be combined with parentAsin.

parentAsinstring
Example:B0ABCDEFGH

Only campaigns advertising any ASIN of this variation family. Cannot be combined with asin.

searchstring
Example:auto

Partial match on campaign name or advertised ASIN. Minimum 3 characters.

includePlacementsboolean

Include the per-placement breakdown (top of search, rest of search, product page, off Amazon) with each placement bid adjustment. Set to false for a smaller, faster response.

sortBy'name' | 'state' | 'bidStrategy' | 'budget' | 'impressions' | 'clicks' | 'ctr' | 'cpc' | 'spend' | 'unitsSold' | 'sales' | 'acos' | 'cvr' | 'tosImpressionShare' | 'tosImpressions' | 'tosClicks' | 'tosSpend' | 'tosSales' | 'tosUnitsSold' | 'rosImpressions' | 'rosClicks' | 'rosSpend' | 'rosSales' | 'rosUnitsSold' | 'ppImpressions' | 'ppClicks' | 'ppSpend' | 'ppSales' | 'ppUnitsSold' | 'offImpressions' | 'offClicks' | 'offSpend' | 'offSales' | 'offUnitsSold' | 'tosBidAdjustment' | 'rosBidAdjustment' | 'ppBidAdjustment' | 'tosCtr' | 'tosCpc' | 'tosAcos' | 'rosCtr' | 'rosCpc' | 'rosAcos' | 'ppCtr' | 'ppCpc' | 'ppAcos' | 'offCtr' | 'offCpc' | 'offAcos'

Sort field. Placement fields are only accepted when includePlacements is true.

sortOrder'ASC' | 'DESC'

Sort direction

state'ENABLED' | 'PAUSED'

Filter by campaign state. Omit to return both ENABLED and PAUSED.

currentPagenumber
Example:1

Page of items to retrieve (default 1)

pageSizenumber
Example:20

Items per page (default 20, max 50)

Response

currentPagenumber required
pageSizenumber required

Number of items per page

hasNextboolean required

True when there is a next page. Otherwise, false

hasPrevboolean required

True when there is a previous page. Otherwise, false

lastPagenumber required

Last page or total page count

totalnumber required

Total number of items

Example response

{
  "currentPage": 1,
  "pageSize": 20,
  "lastPage": 1,
  "total": 1
}

Changes

Changed in 1 of the 10 revisions of this API.1