Skip to content

iPixel Events and Objects

4.1. Required Events

4.1.1. page_view

Trigger this event when a user navigates to a new page on your site. Trigger this event on every page of your site and include these parameters:

Name Type Required Description
user_id string false The unique identifier for the customer. This should be at least six characters.

4.1.2. view_item

Trigger this event when a user lands on a specific product page. To send this event, include parameters:

Name Type Required Description
items Items[] true The items for the event
currency string recommended Currency of the items associated with the event, in ISO 4217 format.
user_id string false The unique identifier for the customer. This should be at least six characters.
value number false Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax.

4.1.3. add_to_cart

This event signifies that an item was added to a cart for purchase.

Name Type Required Description
items Items[] true The items for the event
currency string recommended Currency of the items associated with the event, in ISO 4217 format.
user_id string false The unique identifier for the customer. This should be at least six characters.
value number false Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax.

4.1.4. begin_checkout

This event signifies that a user has begun a checkout.

Name Type Required Description
items Items[] true The items for the event
currency string true Currency of the items associated with the event, in ISO 4217 format.
value number true Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax.
user_id string false The unique identifier for the customer. This should be at least six characters.

4.1.5. purchase

This event signifies when one or more items are purchased by a user.

Name Type Required Description
currency string true Currency of the items associated with the event, in ISO 4217 format.
items Items[] true The items for the event
transaction_id string true The unique identifier of a transaction. The transaction_id parameter helps you avoid getting duplicate events for a purchase.
value number true Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax.
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. This should be at least six characters.

Inmobi recommends the events listed below, but they are not required.

4.2.1. add_payment_info

This event signifies that a user has submitted their payment information in an e-commerce checkout process.

Name Type Required Description
currency string recommended Currency of the items associated with the event, in ISO 4217 format.
items Items[] recommended The items for the event
payment_type Payment Type recommended The payment type used
value number recommended Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax.
user_id string false The unique identifier for the customer. This should be at least six characters.
coupon string false The coupon name/code associated with the event.

4.2.2. generate_lead

This event measures when a lead has been generated (for example, through a form). Log this to understand the effectiveness of your marketing campaigns and how many customers re-engage with your business after remarketing to them.

Name Type Required Description
currency string false Three-letter ISO 4217 code for currency
user_id string false The unique identifier for the customer. This should be at least six characters.
value number false Monetary value of the event
lead_source string false The source of the lead.

4.2.3. sign_up

Trigger this event when a user registers 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
method string recommended The method used for registration
user_id string recommended The unique identifier for the customer. This should be at least six characters.

4.2.4. login

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 recommended The unique identifier for the customer. This should be at least six characters.

4.2.5. view_cart

Trigger this event when a user views their cart. To send this event, include these parameters:

Name Type Required Description
items Items[] true The items for the event
currency string recommended Currency of the items associated with the event, in ISO 4217 format.
value number recommended Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax.
user_id string false The unique identifier for the customer. This should be at least six characters.

4.2.6. remove_from_cart

Trigger this event when a user removes an item from their cart. To send this event, include these parameters:

Name Type Required Description
items Items[] true The items for the event
currency string recommended Currency of the items associated with the event, in ISO 4217 format.
user_id string false The unique identifier for the customer. This should be at least six characters.
value number false Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax.

4.2.7. subscribe

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 Currency of the items associated with the event, in ISO 4217 format.
user_id string false The unique identifier for the customer
value number false Monetary value of the 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 the user searched for
results Items[] recommended The items for the event
user_id string false The unique identifier for the customer. This should be at least six characters.

4.3. Objects

4.3.1. Items

Please ensure that all the fields are named and formatted exactly as shown in the table below:

Name Type Required Description
item_id string true The ID of the item
image_url string recommended The URL to an image of the item. File extension must be .png, .jpg, or .jpeg.
item_category_id string recommended The numeric ID that represents the item's product category. Use the Google Product Category list to identify the appropriate value.
item_name string recommended The name of the item.
item_variant_id string recommended The ID of the item variant, for example a size or color variation of the parent item. Every variant in your catalog must have an item_variant_id that is not shared by any other variant or item.
price number recommended The price of the item for a single unit. If a discount applies, set price to the discounted unit price, and specify the unit discount in the discount parameter.
quantity number Required for add_to_cart, remove_from_cart, and purchase events. Otherwise recommended. Item quantity
affiliation string false The specific supplier, company, or physical store associated with the product
discount number false The unit discount applied to the item
item_brand string false The brand of the item

4.3.2. 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 on delivery
wallet An integrated wallet, like PayPal, Google Pay, Apple Pay, etc.
other Another type of payment not defined above