Analytics Report Types
Important
The Buy with Prime API is offered as a preview and might change as we receive feedback and iterate on the interfaces. We are sharing this early documentation to help you learn about the Buy with Prime API as we write and iterate on the content.
You use the Buy with Prime Analytics interface to track Buy with Prime metrics across your site.
This topic describes the report types that the Buy with Prime API currently supports.
User Event report
The User Events report contains user engagement data such as shoppers browsing a detail page, purchasing items, and so on. The report includes the event name and event ID for events like Page Loads, Prime Badge views, checkout started, checkout completed, and so on.
You collect raw user event data by using the sendUserEvents mutation. For examples, see Send User Events for Buy with Prime.
You then use the startReportTask mutation to trigger report generation. After you start the report generation by using the startReportTask mutation, you use the reportTask query to get the status of the report. When the report is ready, you can get a link to the report by using the reportDownloadLink query. You then download the report, which is in CSV format. For examples, see Get an Analytics Report.
Fields
User Event reports have the following fields. In the reports, the fields are not necessarily in this order.
| Column Name | Description |
|---|---|
| Event Name | The type of event. Examples: Page Load, Click, Widget Load, and so on. |
| Event ID | Unique identifier for the event. Example: e.g. 1a2b3c-4d5e6f7g8-h9i0j1i2l3m4n5. |
| Timestamp | Epoch timestamp, in milliseconds, when the event occurred. Example: 1724543998724. |
| Current URL | The full page URL where the event happened. Example: https://store.com/example-product. |
| Store Domain | Merchant store URL that uniquely identifies a store. Example: https://example-store.com. |
| Page Type | The page where the link was clicked. Examples:
|
| Page Action | Description of what the user took action on. Valid only for click events such as "Place order." |
Example
The following table shows an example of a User Events report.
| Event Name | Page Type | Page Action | Event ID | Timestamp | Current URL | Store Domain |
|---|---|---|---|---|---|---|
| Page Load | product-page-widget | N/A | example-event-id-12345 | 1724543998724 | https://store.com/example-product | https://example-store.com |
| Click | checkout | place order | example-event-id-67890 | 1724543998724 | https://store.com/checkout | https://example-store.com |
Related topics
Updated 2 days ago