POSTs are immediately acknowledged with a 204 if the POST is successfully received and the JSON decoded.
Data errors within the JSON are not acknowledged on this endpoint, but are handled gracefully where possible.
The User Agent
uafield should be accurate, as it is used to determine the form-factor and OS for analytics purposes.
When recording page activity using beacons you must provide the appropriate value for the following:
typ values
Signifies the type of event the beacon is tracking.
typ value | Name | Description |
|---|---|---|
1 | PAGE_VIEWED | Page viewed, of type ptyp |
7 | CUSTOM_SIGNAL | Custom signal For example, requested brochure, visited a certain page. |
ptyp values
Page tracking beacons data must declare what page type it represents using the ptyp field with one of the following values:
ptyp value | Name | Description |
|---|---|---|
1 | PRODUCT_BROWSE | Browse page for any shopping cart. Includes one product ID. |
2 | LOGIN | Logging in to a shopping account. |
3 | LOGIN_THANKS | After logging in to a shopping account. |
4 | REGISTER | Register for a shopping account. |
5 | REGISTER_THANKS | After register for a shopping account. |
6 | CART | Cart page for any shopping cart. Includes 0 or more products. |
7 | CHECKOUT | Cart page during the shopping process. Usually includes all carted products. |
8 | PURCHASE_COMPLETE | Cart page after payment has been made. No products. |
9 | PRODUCT_LIST | A page with a list of products on it, for example, a category page. |
10 | ACCOUNT_EDIT | Account settings page, for example, Magento account dashboard. |
11 | NEWSLETTER_EDIT | Page where newsletter and mailing preferences are set or viewed. |
12 | DNT_PREFERENCE | Not a real page, used to send us Do-not-track / nomail. |
13 | CART_INPAGE | In-page cart update, for example, an ajax cart. |
14 | EMAIL_SEND | Email send For example, UBX webhook. |
15 | EMAIL_OPEN | Email open For example, UBX webhook. |
16 | EMAIL_CLICK | Email clickthrough For example, UBX webhook. |
17 | POPOVER_SHOWN | Popover shown, for popover reporting. |
18 | POPOVER_DISMISS | Popover dismissed, for popover reporting |
19 | POPOVER_SUBMIT | Popover submitted, for popover reporting |