post https://app.freshrelevance.com/app/v1//
POSTs will be immediatelty acknowledged with a 204 if the POST is successfully received and the JSON decoded.
Data errors within the JSON will not be acknowledged on this endpoint, but will be handled gracefully where possible.
Note the User Agent "ua" field should be accurate, as it is used to determine the form-factor & OS for analytics purposes.
When recording page activity using beacons you will need to 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 (e.g. requested brochure, visited a certain page) |
ptyp values
Page tracking beacons data will need to declare what page type it represents using the ptyp field with a value from the table below:
| 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. Probably 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 (e.g. a category page) |
| 10 | ACCOUNT_EDIT | Account settings page e.g. magento account dashboard |
| 11 | NEWSLETTER_EDIT | Page where newsletter / mailing preferences are set / viewed |
| 12 | DNT_PREFERENCE | not a real page, used to send us Do-not-track / nomail - |
| 13 | CART_INPAGE | In page cart update (e.g. an ajax cart) |
| 14 | EMAIL_SEND | Email Send (e.g. UBX webhook) |
| 15 | EMAIL_OPEN | Email Open (e.g. UBX webhook) |
| 16 | EMAIL_CLICK | Email Clickthrough (e.g. 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 |