Mintegral Pixel: Required Events
These events are mandatory for accurate event and conversion attribution and campaign optimization.
Contents
Page View (page_view)
Description:
Triggered when a user visits any critical or product-related page.
Parameters:
|
Parameter |
Type |
Required |
Description |
|
url |
string |
Yes |
Full URL of the current page. |
|
title |
string |
Yes |
The title of the page being viewed. |
Example:
mintegralPixel("track", {
"type": "page_view",
"data": {
"url": "https://shop.example.com/product/123",
"title": "Product Details - Blue Running Shoes"
}
});
Product View (product_view)
Description:
Triggered when a user views the details of a specific product.
Parameters:
|
Parameter |
Type |
Required |
Description |
|
currency |
string |
Yes |
Three-letter ISO 4217 currency code (e.g., USD, EUR). |
|
value |
number |
Yes |
Monetary value of the product, computed as the sum of (price × quantity) across all items. |
|
items |
items[] |
Yes |
Array of product objects (see `items[]` definition at the bottom of this guide). |
Example:
mintegralPixel("track", {
"type": "product_view",
"data": {
"currency": "USD",
"value": 89.99,
"items": [
{
"item_variant_id": "sku123-blue-42",
"item_id": "sku123",
"item_name": "Air Sneakers",
"price": 89.99,
"quantity": 1,
"image_url": "https://cdn.example.com/images/sku123.jpg"
}
]
}
});
⚠️ Note: For items like "item_variant_id", "item_id", "item_name", please insert your own internal product naming, SKU, or ID number in the field after each item.
For instance, our example above uses "item_name": "Air Sneakers". For your e-commerce store, the name of the item would be unique to what you're selling as well as the ID number and SKU of the items you're listing.
Add to Cart (product_add_to_cart)
Description:
Triggered when a user adds one or more products to the shopping cart.
Parameters:
|
Parameter |
Type |
Required |
Description |
|
currency |
string |
Yes |
Three-letter ISO 4217 currency code (e.g., USD, EUR). |
|
value |
number |
Yes |
Monetary value of products added to card, computed as the sum of (price × quantity) across all items. |
|
items |
items[] |
Yes |
Array of product objects (see `items[]` definition at the bottom of this guide). |
Example:
mintegralPixel("track", {
"type": "product_add_to_cart",
"data": {
"currency": "USD",
"value": 179.98,
"items": [
{
"item_variant_id": "sku123-blue-42",
"item_id": "sku123",
"item_name": "Air Sneakers",
"price": 89.99,
"quantity": 2,
"image_url": "https://cdn.example.com/images/sku123.jpg"
}
]
}
});
Begin Checkout (begin_checkout)
Description:
Triggered when a user starts the checkout process.
Parameters:
|
Parameter |
Type |
Required |
Description |
|
currency |
string |
Yes |
Three-letter ISO 4217 currency code (e.g., USD, EUR). |
|
value |
number |
Yes |
Monetary value of products at the start of payment, computed as the sum of (price × quantity) across all items. |
|
items |
items[] |
Yes |
Array of product objects (see `items[]` definition at the bottom of this guide). |
Example:
mintegralPixel("track", {
"type": "begin_checkout",
"data": {
"currency": "USD",
"value": 179.98,
"items": [
{
"item_variant_id": "sku123-blue-42",
"item_id": "sku123",
"item_name": "Air Sneakers",
"price": 89.99,
"quantity": 2,
"image_url": "https://cdn.example.com/images/sku123.jpg"
}
]
}
});
Purchase (purchase)
Description:
Triggered when a user completes a transaction and payment is successful.
Parameters:
|
Parameter |
Type |
Required |
Description |
|
currency |
string |
Yes |
Three-letter ISO 4217 currency code (e.g., USD, EUR). |
|
value |
number |
Yes |
Monetary value of products purchased, computed as the sum of (price × quantity) across all items (excluding shipping and tax). |
|
items |
items[] |
Yes |
Array of product objects (see `items[]` definition at the bottom of this guide). |
|
transaction_id |
string |
Yes |
Unique identifier for the transaction. |
|
shipping |
number |
No |
Shipping cost of the order. |
|
tax |
number |
No |
Applicable tax value for the order. |
Example:
mintegralPixel("track", {
"type": "purchase",
"data": {
"currency": "USD",
"value": 179.98,
"items": [
{
"item_variant_id": "sku123-blue-42",
"item_id": "sku123",
"item_name": "Air Sneakers",
"price": 89.99,
"quantity": 2,
"image_url": "https://cdn.example.com/images/sku123.jpg"
}
],
"transaction_id": "ORDER10001",
"shipping": 5.0,
"tax": 0.0
}
});
Mintegral Pixel: Recommended Events
These events are optional but highly recommended for enhancing event granularity and enabling full-funnel optimization.
Add Payment Info (add_payment_info)
Description:
Triggered when a user provides or updates their payment information.
Parameters:
|
Parameter |
Type |
Required |
Description |
|
currency |
string |
Yes |
Three-letter ISO 4217 currency code (e.g., USD, EUR). |
|
value |
number |
Yes |
Monetary value of products, computed as the sum of (price × quantity) across all items. |
|
items |
items[] |
Yes |
Array of product objects (see `items[]` definition at the bottom of this guide). |
|
payment_type |
string |
Yes |
Type of payment ( see `Payment Types` definitions at the bottom of this guide). |
Search (search)
Description:
Triggered when a user performs a product search.
Parameters:
|
Parameter |
Type |
Required |
Description |
|
keywords |
string |
Yes |
Search term entered by the user. |
|
results |
items[] |
No |
Array of product items returned from the search. |
Cart View (cart_view)
Description:
Triggered when a user opens or views the shopping cart.
Parameters:
|
Parameter |
Type |
Required |
Description |
|
currency |
string |
Yes |
Three-letter ISO 4217 currency code (e.g., USD, EUR). |
|
value |
number |
Yes |
Monetary value of products in the shopping cart, computed as the sum of (price × quantity) across all items. |
|
items |
items[] |
Yes |
Array of product objects (see `items[]` definition). |
Remove from Cart (product_remove_from_cart)
Description:
Triggered when a user removes one or more products from the shopping cart.
Parameters:
|
Parameter |
Type |
Required |
Description |
|
currency |
string |
Yes |
Three-letter ISO 4217 currency code (e.g., USD, EUR). |
|
value |
number |
Yes |
Monetary value of products removed from card, computed as the sum of (price × quantity) across all items. |
|
items |
items[] |
Yes |
Array of product objects (see `items[]` definition below). |
Product Item Object (`items[]`)
The `items[]` array is required in most e-commerce events. Each object in the array should represent a product with the following properties:
|
Field |
Type |
Required |
Description |
|
item_variant_id |
string |
Yes |
The ID of the item variant. |
|
item_id |
string |
Yes |
Unique identifier for the product. |
|
item_name |
string |
Yes |
Descriptive product name. |
|
price |
number |
Yes |
Unit price of the product. |
|
quantity |
number |
Yes |
Number of units for this product. |
|
image_url |
string |
Yes |
The URL to an image of the item. |
|
discount |
number |
No |
The unit discount applied to the item. |
|
item_brand |
string |
No |
The brand of the item. |
Supported Payment Types
Below are the standardized payment type values to be used for the payment_type parameter in tracking events. Consistent use of these values helps ensure accurate reporting and analysis.
|
Payment Type Key |
Description |
|
|
Payment made using credit or debit cards (e.g., Visa, MasterCard, Amex) |
|
|
Payment via Alipay digital wallet |
|
|
Payment via WeChat Pay digital wallet |
|
|
Payment via PayPal |
|
|
Payment via Apple Pay |
|
|
Payment via Google Pay |
|
|
Payment via online banking transfer |
|
|
Payment by cash upon product delivery (COD) |
|
|
Payment using prepaid or gift cards |
|
|
Other or unspecified payment methods |
Usage Notes
-
Always use the exact key strings listed above when passing the
payment_typeparameter. -
If the payment method does not match any listed type, use
other. -
The
payment_typeparameter helps in campaign attribution and user payment behavior analysis.