Endpoints
The report generation uses an asynchronous endpoint that is used to receive the report creation request (using a POST request); then, using the reportid generated, it’s possible to check the report status and download the output results using the following GET endpoint requests.
| Verb | Endpoint | Description |
|---|---|---|
| POST | /retail-media/reports/revenue | Request a retailer revenue report creation |
| GET | /reports/{reportId}/status | Get status of a specific report |
| GET | /reports/{reportId}/output | Download output of a specific report |
Attributes
| Attribute | Data Type | Description |
|---|---|---|
id | string | Supply Account ID to pull results forNote: for apps with access to multiple supply accounts, it is also possible to use an ids array for multiple IDs, allowing to pull results across multiple accounts. e.g. "ids":["supplyAccountId_1","supplyAccountId_2"]Accepted values: int64 Writeable? N / Nullable? N |
reportType | enum | Report types are pre-packaged reports that allow the specification of the report breakdown. They enable reports to view revenue distribution by advertiser, brand, environment, page category, and page type. The metrics and dimensions in these report types are limited. Use the metrics and dimensions arrays to build your report for additional fields.- *Note**: when metrics and dimensions are used, the report type is ignored.Accepted values: advertiser, brand, environment, productCategory, pageType Writeable? N / Nullable? Y |
revenueType | enum | The revenue type used to filter report results. If the revenue type filter is not specified, the report will return all existing revenue data for sponsored products and preferred deals within the specified timeframe.Accepted values: auction, preferred Writeable? N / Nullable? Y |
soldBy | enum | The sales channel of indirect sold, direct sold, or private market. This is an optional filter that can be used to narrow down results.Accepted values: directSold, indirectSold, privateMarket Writeable? N / Nullable? Y |
buyType | enum | The campaign buying strategy. This optional filter can be used to filter down resultsAccepted values: auction, preferredDeals, sponsorship Writeable? N / Nullable? Y |
skuRelations | enum | The attributed rule used to match an impression/click to a sale. The filter will narrow down results of the attributed rules set by the advertiser at the campaign level.Accepted values: sameSku, sameParentSku, sameCategory, sameBrand, sameSeller Writeable? N / Nullable? N |
format | enum | The format type the report should return resultsAccepted values: json, json-compact, json-newline, csv Writeable? N / Nullable? N |
campaignType | enum | The campaign type to filter resultsAccepted values: all, sponsoredProducts, onSiteDisplays Default: all Writeable? N / Nullable? N |
salesChannel | enum | The sales channel where attributed sales originatedAccepted values: all, online, offline Default: all Writeable? N / Nullable? N |
advertiserTypes | list<string> | The advertiser type where campaigns originated fromAccepted values: retailer, brand, seller Writeable? N / Nullable? N |
clickAttributionWindow | enum | The post-click attribution window, defined as the maximum number of days considered between a click and a conversion for attribution; conversions are attributed to the date of conversion, not the date of click. Defaults to campaign settings if omitted; must be specified if viewAttributionWindow is one of the accepted values.Accepted values: none, 7D, 14D, 30D Writeable? N / Nullable? Y |
viewAttributionWindow | enum | The post-view attribution window, defined as the maximum number of days considered between an impression and a conversion for attribution; conversions are attributed to the date of conversion, not the date of impression. Defaults to campaign settings if omitted; must be less than or equal to clickAttributionWindow; must be specified if clickAttributionWindow is one of the accepted values.Accepted values: none, 1D, 7D, 14D, 30D Writeable? N / Nullable? Y |
dimensions | list<enum> | An array of strings used to define which dimensions to see in the reportAccepted values: refer to Metrics and Dimensions for the complete list of supported dimensions Writeable? N / Nullable? Y |
metrics | list<enum> | An array of strings used to define which metrics to see in the reportAccepted values: refer to Metrics and Dimensions for the complete list of supported metrics Writeable? N / Nullable? Y |
startDate | timestamp | Start date of the report (inclusive)Accepted values: yyyy-mm-ddThh:mm:ss(in ISO-8601 ) Writeable? N / Nullable? N |
endDate | timestamp | End date of the report (inclusive)Accepted values: yyyy-mm-ddThh:mm:ss(in ISO-8601 ) Writeable? N / Nullable? N |
timezone | string | Time zone to consider in the metrics calculation,startDate and endDateAccepted values: IANA (TZ database) time zones (example: America/New_York, Europe/Paris, Asia/Tokyo, UTC) Default: UTC Writeable? N / Nullable? Y |
Metrics and DimensionsFor a complete list of all supported metrics and dimension, check out the Metrics and Dimensions
Generate Revenue Report
Sample RequestGet status of specific report
Sample RequestDownload Output of a Specific Report
Sample RequestResponses
| Response | Description |
|---|---|
🔵 200 | Call executed with success |
🔴 400 | Common Validation Errors
|