AXON Pixel Events and Objects
Required Events
page_view Event
Send the page_view event to track Page View events with the AXON Pixel.
view_item Event
Trigger this event when a user lands on a specific product page. To send this event, include these parameters:
| Name | Type | Required | Description |
|---|---|---|---|
currency | string | true | Three-letter ISO 4217 code for currency |
items | AXONItem[] | true | The items for the event |
value | number | false | Monetary value of the event, calculated by the sum of price × quantity for each item |
add_to_cart Event
Trigger this event when a user adds an item to their cart. To send this event, include these parameters:
| Name | Type | Required | Description |
|---|---|---|---|
currency | string | true | Three-letter ISO 4217 code for currency |
items | AXONItem[] | true | The items for the event |
value | number | recommended | Monetary value of the items added to cart, calculated by the sum of price × quantity for each item |
begin_checkout Event
Trigger this event when a user initiates the checkout process. To send this event, include these parameters:
| Name | Type | Required | Description |
|---|---|---|---|
currency | string | true | Three-letter ISO 4217 code for currency |
items | AXONItem[] | true | The items for the event |
value | number | true | Monetary value of the event, calculated by the sum of price × quantity for each item |
purchase Event
Trigger this event when a user makes a purchase. To send this event, include these parameters:
| Name | Type | Required | Description |
|---|---|---|---|
currency | string | true | Three-letter ISO 4217 code for currency |
items | AXONItem[] | true | The items for the event |
transaction_id | string | true | The unique identifier of a transaction |
value | number | true | Monetary value of the event, calculated by the sum of price × quantity for each item |
shipping | number | recommended | Shipping cost associated with the transaction |
tax | number | recommended | Tax cost associated with a transaction |
user_id | string | recommended | The unique identifier for the customer |
Recommended Events
The remaining events listed below are recommended but not required:
add_payment_info Event
Trigger this event when a customer submits their payment information to the site. For example, when a user fills in their payment information when they make a purchase. To send this event, include these parameters:
| Name | Type | Required | Description |
|---|---|---|---|
currency | string | true | Three-letter ISO 4217 code for currency |
items | AXONItem[] | recommended | The items for the event |
payment_type | Payment Type | recommended | The payment type used |
value | number | recommended | Monetary value of the event, calculated by the sum of price × quantity for each item |
generate_lead Event
Trigger this event when a potential customer expresses interest, typically by submitting a form. For example, when a user fills out a contact form to receive more information about a product. To send this event, include these parameters:
| Name | Type | Required | Description |
|---|---|---|---|
currency | string | false | Three-letter ISO 4217 code for currency |
user_id | string | false | The unique identifier for the customer |
value | number | false | Monetary value of the event |
login Event
Trigger this event when a user logs into an account on the site. To send this event, include these parameters:
| Name | Type | Required | Description |
|---|---|---|---|
user_id | string | true | The unique identifier for the customer |
sign_up Event
Trigger this event when a user signs up for an account on the site. For example, when a user registers for a new account by using their email or social media login. To send this event, include these parameters:
| Name | Type | Required | Description |
|---|---|---|---|
user_id | string | true | The unique identifier for the customer |
method | string | recommended | The method used for sign up |
search Event
Trigger this event when a user uses a search bar to search for content on your site. To send this event, include these parameters:
| Name | Type | Required | Description |
|---|---|---|---|
search_term | string | true | The term that was searched for |
results | AXONItem[] | recommended | The items for the event |
subscribe Event
Trigger this event when a user subscribes to a service. For example, when a user subscribes to a premium content service, such as an online magazine. Often this means that the user has paid for a membership. To send this event, include these parameters:
| Name | Type | Required | Description |
|---|---|---|---|
currency | string | false | Three-letter ISO 4217 code for currency |
user_id | string | false | The unique identifier for the customer |
value | number | false | Monetary value of the event |
remove_from_cart Event
Trigger this event when a user removes an item from their cart. To send this event, include these parameters:
| Name | Type | Required | Description |
|---|---|---|---|
currency | string | true | Three-letter ISO 4217 code for currency |
items | AXONItem[] | true | The items for the event |
value | number | recommended | Monetary value of the event, calculated by the sum of price × quantity for each item |
Objects
The AXON Item Object
AXONItem is a common object required with most events.
quantity, price, item_name, and item_id are required with this object and must be named and formatted exactly as shown in the table below:
| Name | Type | Required | Description |
|---|---|---|---|
item_id | string | true | The ID of the item |
item_name | string | true | The name of the item |
price | number | true | The monetary value of the item (in the user’s currency). If a discount applies, set price to the discounted price, and specify the discount in the discount parameter. |
quantity | number | true1 | Item quantity |
image_url | string | recommended | The URL to an image of the item |
item_category | string | recommended | The first category hierarchy for the item |
item_variant | string | recommended | The item variant or code |
affiliation | string | false | The specific supplier, company, or physical store associated with the product |
discount | number | false | The discount applied to the item |
item_brand | string | false | The brand of the item |
1 quantity not required for view_item event
Payment Types
The supported payment methods are:
| Name | Description |
|---|---|
credit_card | A saved or manually entered credit card |
deferred | A deferred payment, if you plan to collect payment later |
redeemable | A redeemable payment method, like a gift card or store credit |
payment_on_delivery | A payment that is collected upon delivery |
wallet | An integrated wallet, like PayPal, Google Pay, Apple Pay, etc. |
other | Another type of payment not defined above |