Event Schema Reference

This page lists each event Appier logs or defines, with its event-specific properties.

Events: Events that are currently in use, with their labels and event-specific properties.
Deprecated events: Events that are no longer in use but may still appear in your data from older SDK versions.
AIRIS system event properties: Properties that AIRIS adds automatically to every event it tracks. They aren't repeated on each event card.

How to read this page

Event labels

This reference uses labels to tell you who sends the event and whether it affects billing.

Label	Meaning
Default	Appier's SDKs or backend log this event automatically. You don't need to add any code.
System-defined	Appier defines the event name and its properties, and you send the event. Send the event name and its properties exactly as defined so Appier features can use the data. The data logging guidelines apply.
Billable	The event counts toward your monthly event quota.
MAU billable	The event counts the user toward your monthly active user (MAU) quota.

Event property labels

Include properties labeled Required every time you log the event. Some Appier features need them to work. For system-defined events, all other properties are recommended, as they can enable more use cases and improve how Appier features perform.

Events

`accept_NTN`

DefaultBillable

Generated by BotBonnie when the user agrees to receive recurring notification messages. The permission details are also saved to the ntn user property.

Property

Type

Description

token

string

Token for sending notification messages to the user.

Example: "1234567890123456789"

topic

string

Topic of the notification messages.

Example: "default"

expired

integer

When the permission expires, as a Unix timestamp in milliseconds.

Example: 2145916800000

frequency

string

How often notification messages can be sent: "DAILY", "WEEKLY", or "MONTHLY".

Example: "WEEKLY"

`accept_OTN`

DefaultBillable

Generated by BotBonnie when the user agrees to receive a one-time notification message.

Property

Type

Description

token

string

Token for sending notification messages to the user.

Example: "1234567890123456789"

topic

string

Topic of the notification messages.

Example: "default"

expired

integer

When the permission expires, as a Unix timestamp in milliseconds.

Example: 2145916800000

frequency

string

How often notification messages can be sent: "DAILY", "WEEKLY", or "MONTHLY".

Example: "WEEKLY"

`account_link`

DefaultBillable

Generated by BotBonnie when the user links their BotBonnie identity to an external member account. The linked account ID is also saved to the account_linked user property.

Property

Type

Description

account_linked

string

ID of the linked external account.

Example: "MEMBER-ID-123"

`account_unlink`

DefaultBillable

Generated by BotBonnie when the user unlinks their BotBonnie identity from an external member account.

Property

Type

Description

account_linked

string

ID of the unlinked external account.

Example: "MEMBER-ID-123"

`actionclicked`

Default

Logged when the user taps an action button on a push notification, including the copy-code button.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

actionid

string

ID of the tapped action button, as defined in the push payload.

Example: "btn_view"

`add_tag`

DefaultBillable

Generated by BotBonnie when a tag is added to the user. The user's full tag list is also saved to the bb_tag_ids and bb_tag_names user properties.

Property

Type

Description

bb_tag_ids

string[]

IDs of the added tags.

Example: ["tag-AbC123xYz"]

bb_tag_names

string[]

Names of the added tags.

Example: ["VIP"]

`aiq_cg_received`

Default

Logged when an in-app or in-web campaign is triggered for a user in the experiment's control group. The message is not shown, and this event is logged instead of qg_inapp_displayed or qg_inweb_displayed.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

type

string

In-app message type (Android); always 0 for the control group.

Example: "0"

`aiq_deep_link_redirected`

Default

Logged when the app is opened through a deep link or universal link, with the original URL, its UTM and attribution parameters, and the time of the last app launch.

Property

Type

Description

url

string

Original deep link or universal link URL that opened the app.

Example: "myapp://products/123?utm_source=newsletter&asi=a1b2c3d4e5f6"

asi

string

Appier ad attribution ID taken from the deep link, used for ad attribution.

Example: "a1b2c3d4e5f6"

timestamp

integer

Time the deep link was handled, in epoch milliseconds.

Example: 1727671200000

last_app_launched_time

integer

Time of the previous app launch before this deep link, in epoch milliseconds.

Example: 1727671200000

utm_source

string

UTM source from the deep link that opened the app. Repeated values are joined with commas.

Example: "newsletter"

utm_medium

string

UTM medium from the deep link that opened the app. Repeated values are joined with commas.

Example: "email"

utm_campaign

string

UTM campaign name from the deep link that opened the app. Repeated values are joined with commas.

Example: "spring_sale"

utm_term

string

UTM term (paid search keyword) from the deep link that opened the app. Repeated values are joined with commas.

Example: "running shoes"

utm_content

string

UTM content, used to tell apart ads or links in the same campaign, from the deep link that opened the app. Repeated values are joined with commas.

Example: "banner_a"

utm_id

string

UTM campaign ID from the deep link that opened the app. Repeated values are joined with commas.

Example: "cmp_2024_01"

utm_source_platform

string

UTM source platform (GA4 parameter) from the deep link that opened the app. Repeated values are joined with commas.

Example: "google_ads"

utm_creative_format

string

UTM creative format (GA4 parameter) from the deep link that opened the app. Repeated values are joined with commas.

Example: "display"

utm_marketing_tactic

string

UTM marketing tactic (GA4 parameter) from the deep link that opened the app. Repeated values are joined with commas.

Example: "prospecting"

`aiq_geofence`

Default

Logged when the Android SDK sends a batch of geofence transitions together. Each transition is included as a record in the transitions property. Only logged when geofencing is enabled for your account.

Property

Type

Description

transitions

string

JSON array of transition records, sent as one string. Each record has latitude, longitude, timestamp (epoch seconds), provider, geofence_id, geofence_name, geofence_latitude, geofence_longitude, geofence_radius, transition (1 = enter, 2 = exit), and isMock; altitude, accuracy, speed, bearing, bearingAccuracyDegrees, verticalAccuracy, speedAccuracy, and isComplete are added when the device reports them.

Example: [{"geofence_id": "1024", "transition": 1, "latitude": 25.0480, "longitude": 121.5172, "timestamp": 1727671200}]

`aiq_kakao_pending`

Default

Logged when Infobip reports that a Kakao campaign message is not yet delivered (pending).

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the vendor's report.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the vendor's report, in epoch seconds.

Example: 1727671200

vendor

string

Vendor that reported the status: kakaoinfobip.

Example: "kakaoinfobip"

error

string

Error category from Infobip: the first part of Infobip's error group name.

Example: "OK"

infobip_status_name

string

Status name reported by Infobip.

Example: "PENDING_ENROUTE"

infobip_error_name

string

Error name reported by Infobip.

Example: "NO_ERROR"

infobip_mccmnc

string

Mobile network code (MCC+MNC) reported by Infobip.

Example: "46692"

`aiq_kakao_rejected`

Default

Logged when Infobip reports that a Kakao campaign message could not be delivered.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the vendor's report.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the vendor's report, in epoch seconds.

Example: 1727671200

vendor

string

Vendor that reported the failure: kakaoinfobip.

Example: "kakaoinfobip"

error

string

Error category from Infobip: the first part of Infobip's error group name.

Example: "USER"

infobip_status_name

string

Status name reported by Infobip.

Example: "UNDELIVERABLE_NOT_DELIVERED"

infobip_error_name

string

Error name reported by Infobip.

Example: "EC_ABSENT_SUBSCRIBER"

infobip_mccmnc

string

Mobile network code (MCC+MNC) reported by Infobip.

Example: "46692"

`aiq_mms_operation_failed`

Default

Logged when an MMS send request fails as a whole, because Mitake returned an error for the request or AIQUA could not complete it, so no message was accepted.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

ts

integer

Time AIQUA recorded the failure, in epoch seconds.

Example: 1727671200

vender

string

Sender that failed: mmsmitake.

Example: "mmsmitake"

error_code

string

Error code returned by Mitake for the request, or AIQUA's internal error code.

Example: "1007"

error_description

string

Error description returned by Mitake for the request, or AIQUA's internal error description.

Example: "Quantities of concurrent connections for this account are over the upper limit."

`aiq_mms_rejected`

Default

Logged when Mitake reports that an MMS campaign message could not be delivered.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the vendor's report.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the vendor's report, in epoch seconds.

Example: 1727671200

vender

string

Vendor that reported the failure: mmsmitake.

Example: "mmsmitake"

status_code

string

Failure status code reported by Mitake.

Example: "4"

status_desc

string

Description of the Mitake failure status code.

Example: "Invalid recipient"

`aiq_mms_sending_failed`

Default

Logged when Mitake accepts an MMS send request but rejects an individual message in it.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

ts

integer

Time AIQUA recorded the failure, in epoch seconds.

Example: 1727671200

vender

string

Sender that failed: mmsmitake.

Example: "mmsmitake"

vendortrackid

string

Message ID Mitake assigned to the rejected message.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

error_code

string

Status code Mitake returned for the message.

Example: "4"

error_description

string

Status description Mitake returned for the message.

Example: "Invalid recipient"

`aiq_notification_blocked`

Default

Logged when a push notification is received but not shown, because it arrived during the configured blackout window or after it expired. Android only.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

`aiq_onsite_experience_clicked`

Default

Logged when the user clicks a link in content added by an onsite experience campaign.

Property

Type

Description

experience_id

string

ID of the onsite experience campaign.

Example: "exp_301"

creative_id

string

ID of the creative shown in the experience.

Example: "crv_77"

`aiq_onsite_experience_displayed`

Default

Logged when an onsite experience campaign changes the website content for the user.

Property

Type

Description

experience_id

string

ID of the onsite experience campaign.

Example: "exp_301"

creative_id

string

ID of the creative shown in the experience.

Example: "crv_77"

`aiq_sms_pending`

Default

Logged when the SMS vendor reports that an SMS campaign message is accepted but not yet delivered (pending or buffered).

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the vendor's report.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the vendor's report, in epoch seconds.

Example: 1727671200

msgcount

integer

Number of SMS credits the message used (Vonage).

Example: 1

vonage_status

string

Delivery status reported by Vonage.

Example: "buffered"

vonage_err_code

string

Error code reported by Vonage.

Example: "0"

vonage_network_code

string

Mobile network code reported by Vonage.

Example: "46692"

error

string

Error category reported by Infobip SMS: the first part of Infobip's error group name.

Example: "OK"

infobip_status_name

string

Status name reported by Infobip SMS.

Example: "PENDING_ENROUTE"

infobip_error_name

string

Error name reported by Infobip SMS.

Example: "NO_ERROR"

infobip_mccmnc

string

Mobile network code (MCC+MNC) reported by Infobip SMS.

Example: "46692"

`aiq_sms_rejected`

Default

Logged when the SMS vendor reports that an SMS campaign message could not be delivered.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the vendor's report.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the vendor's report, in epoch seconds.

Example: 1727671200

error

string

Error category: "HANDSET", "USER", "OPERATOR", or "VENDOR" (mapped from Vonage error codes); the first part of Infobip's error group name; or "VENDOR" for Mitake.

Example: "HANDSET"

msgcount

integer

Number of SMS credits the message used (Vonage).

Example: 1

vonage_status

string

Delivery status reported by Vonage.

Example: "rejected"

vonage_err_code

string

Error code reported by Vonage.

Example: "6"

vonage_network_code

string

Mobile network code reported by Vonage.

Example: "46692"

infobip_status_name

string

Status name reported by Infobip (Infobip SMS only).

Example: "UNDELIVERABLE_NOT_DELIVERED"

infobip_error_name

string

Error name reported by Infobip (Infobip SMS only).

Example: "EC_ABSENT_SUBSCRIBER"

infobip_mccmnc

string

Mobile network code (MCC+MNC) reported by Infobip (Infobip SMS only).

Example: "46692"

vender

string

Vendor that reported the failure: mitake (Mitake SMS only).

Example: "mitake"

status_code

string

Status code reported by Mitake (Mitake SMS only).

Example: "0"

status_flag

string

Status flag reported by Mitake (Mitake SMS only).

Example: "5"

status_flag_meaning

string

Meaning of the Mitake status flag. Mitake SMS only.

Example: "內容有錯誤"

status_string

string

Status string reported by Mitake. Mitake SMS only.

Example: "SYNTAXE"

`aiq_switch_app_id`

Default

Logged when the app switches the SDK to a different Appier app ID, with the previous and new IDs.

Property

Type

Description

from

string

Appier app ID the SDK was using before the switch.

Example: "0123456789abcdef0123"

to

string

Appier app ID the SDK switched to.

Example: "abcdef0123456789abcd"

`app_launched`

DefaultBillableMAU billable

Logged each time the app is launched or brought to the foreground. Not logged when the app starts in the background (for example, woken by a silent push).

No event-specific properties.

`appier_property_update`

DefaultBillable

Logged each time a user property changes value, with the property's new and previous value. Only visible in AIRIS.

Property

Type

Description

property

string

Name of the user property that changed.

Example: "membership_level"

value

string

New value of the user property.

Example: "gold"

last

string

Previous value of the user property. Empty when the property had no value before.

Example: "silver"

`beacon`

DefaultBillable

Generated by BotBonnie when the user enters the range of a LINE Beacon.

Property

Type

Description

hwid

string

Hardware ID of the LINE Beacon.

Example: "0000012345"

`button click`

DefaultBillable

Generated by AIRIS when the user clicks a link, button, or submit input on your website. Click tracking is on by default. AIRIS also adds the AIRIS system event properties.

Property

Type

Description

text

string

Text of the clicked element.

Example: "Add to cart"

url

string

Link URL of the clicked element. Sent only when the element is a link.

Example: "https://www.example.com/cart"

page_url

string

URL of the page where the click happened.

Example: "https://www.example.com/products/123"

page_title

string

Title of the page where the click happened.

Example: "Running Shoes X1 | Example Store"

tag_name

string

HTML tag of the clicked element. Older data may use tagname instead.

Example: "button"

classname

string

CSS classes of the clicked element.

Example: "btn btn-primary"

type

string

Type attribute of the clicked element.

Example: "submit"

title

string

Title attribute of the clicked element.

Example: "Add this item to your cart"

pointer_type

string

Input used for the click: "mouse", "touch", or "pen".

Example: "mouse"

dom_path

string

Location of the clicked element in the page, as a CSS path.

Example: "body > main > section[1] > form#cart-form > button"

`cancel_NTN`

DefaultBillable

Generated by BotBonnie when the user stops receiving recurring notification messages.

Property

Type

Description

token

string

Token for sending notification messages to the user.

Example: "1234567890123456789"

topic

string

Topic of the notification messages.

Example: "default"

expired

integer

When the permission expires, as a Unix timestamp in milliseconds.

Example: 2145916800000

frequency

string

How often notification messages can be sent: "DAILY", "WEEKLY", or "MONTHLY".

Example: "WEEKLY"

`category_viewed`

System-definedBillable

Log when the user views a product category page.

Property

Type

Description

category_name

string

A comma-separated list of categories. Category names must match the categories in your data feed.

Example: "Shoes,Running"

user_id

string

The identifier of the user who initiated the event.

Example: "member_10023"

Event logging sample

appier('event', 'category_viewed', {
  category_name: 'Shoes,Running',
  user_id: 'member_10023'
});

var properties: [String: Any] = [:]
properties["category_name"] = "Shoes,Running"
properties["user_id"] = "member_10023"
QGSdk.getSharedInstance().logEvent("category_viewed",
                                   withParameters: properties)

try {
    val properties = JSONObject()
    properties.put("category_name", "Shoes,Running")
    properties.put("user_id", "member_10023")
    QG.getInstance(context).logEvent("category_viewed", properties)
} catch (e: JSONException) {
    // Handle the exception
}

`checkout_completed`

System-definedBillable

Log once per order when the user completes checkout. Use it as the conversion event, and log a product_purchased event for each product in the order. Include the order's total value as valueToSum.

Property

Type

Description

order_idRequired

string

The unique identifier for the order.

Example: "ORD-20240930-001"

order_quantity

integer

Total number of items in the order.

Example: 2

order_amount

float

The order amount for this event.

Example: 1599.98

user_id

string

The identifier of the user who initiated the event.

Example: "member_10023"

currency

string

Currency of the prices in this event, as a three-letter ISO 4217 code.

Example: "TWD"

Event logging sample

appier('event', 'checkout_completed', {
  order_id: 'ORD-20240930-001',
  order_quantity: 2,
  order_amount: 1599.98,
  user_id: 'member_10023',
  currency: 'TWD'
}, 1599.98);

var properties: [String: Any] = [:]
properties["order_id"] = "ORD-20240930-001"
properties["order_quantity"] = 2
properties["order_amount"] = 1599.98
properties["user_id"] = "member_10023"
properties["currency"] = "TWD"
QGSdk.getSharedInstance().logEvent("checkout_completed",
                                   withParameters: properties,
                                   withValueToSum: 1599.98)

try {
    val properties = JSONObject()
    properties.put("order_id", "ORD-20240930-001")
    properties.put("order_quantity", 2)
    properties.put("order_amount", 1599.98)
    properties.put("user_id", "member_10023")
    properties.put("currency", "TWD")
    QG.getInstance(context).logEvent("checkout_completed", properties, 1599.98)
} catch (e: JSONException) {
    // Handle the exception
}

`checkout_initiated`

System-definedBillable

Log when the user starts the checkout process.

Property

Type

Description

user_id

string

The identifier of the user who initiated the event.

Example: "member_10023"

currency

string

Currency of the prices in this event, as a three-letter ISO 4217 code.

Example: "TWD"

Event logging sample

appier('event', 'checkout_initiated', {
  user_id: 'member_10023',
  currency: 'TWD'
});

var properties: [String: Any] = [:]
properties["user_id"] = "member_10023"
properties["currency"] = "TWD"
QGSdk.getSharedInstance().logEvent("checkout_initiated",
                                   withParameters: properties)

try {
    val properties = JSONObject()
    properties.put("user_id", "member_10023")
    properties.put("currency", "TWD")
    QG.getInstance(context).logEvent("checkout_initiated", properties)
} catch (e: JSONException) {
    // Handle the exception
}

`click`

DefaultBillableMAU billable

Generated by BotBonnie when the user clicks a button or postback action in a bot message.

Property

Type

Description

value

string

ID of the bot message module that contains the button.

Example: "module-AbC123xYz"

`content_detail_viewed`

System-definedBillable

Log when a key detail page is displayed, such as a service, program, plan, property, or consultation detail. Log it only after the page is successfully displayed. Website only.

Property

Type

Description

content_idRequired

string

Unique ID of the content shown on the page.

Example: "SERVICE-123"

content_name

string

Display name of the content.

Example: "Financial Planning Consultation"

content_type

string

Type of content.

Example: "service"

content_category

string

Category of the content, as defined by your business.

Example: "financial_planning"

content_link

string

Full URL of the content detail page.

Example: "https://example.com/services/financial-planning"

Event logging sample

appier('event', 'content_detail_viewed', {
  content_id: 'SERVICE-123',
  content_name: 'Financial Planning Consultation',
  content_type: 'service',
  content_category: 'financial_planning',
  content_link: 'https://example.com/services/financial-planning'
});

`delete_params`

DefaultBillable

Generated by BotBonnie when the user's custom fields or basic profile data are deleted. Only the deleted fields are sent.

Property

Type

Description

bb_params_<encoded field name>

object

A deleted custom field, with its value (value) and field name (name). The property name ends with the encoded field name.

Example: {"value": "2025-08-13", "name": "Membership expiry date"}

`download`

DefaultBillable

Generated by AIRIS when the user clicks a link on your website to a downloadable file, such as a PDF, ZIP, Office document, or video. Download tracking is on by default. The UTM and campaign properties describe the visit, not the file. AIRIS also adds the AIRIS system event properties.

Property

Type

Description

url

string

URL of the downloaded file.

Example: "https://www.example.com/files/catalog.pdf"

utm_source

string

UTM source of the visit, from the landing page URL.

Example: "newsletter"

utm_medium

string

UTM medium of the visit, from the landing page URL.

Example: "email"

utm_campaign

string

UTM campaign name of the visit, from the landing page URL.

Example: "spring_sale"

utm_term

string

UTM term of the visit, from the landing page URL.

Example: "running shoes"

utm_content

string

UTM content of the visit, from the landing page URL.

Example: "banner_a"

utm_id

string

UTM campaign ID of the visit, from the landing page URL.

Example: "cmp_2024_01"

utm_aa_crtv_id

string

Appier ad creative ID of the visit, from the landing page URL.

Example: "1234567"

campaign_source

string

Campaign source of the visit, from AIRIS campaign tracking.

Example: "newsletter"

campaign_medium

string

Campaign medium of the visit, from AIRIS campaign tracking.

Example: "email"

campaign_name

string

Campaign name of the visit, from AIRIS campaign tracking.

Example: "spring_sale"

campaign_term

string

Campaign term of the visit, from AIRIS campaign tracking.

Example: "running shoes"

campaign_content

string

Campaign content of the visit, from AIRIS campaign tracking.

Example: "banner_a"

campaign_id

string

Campaign ID of the visit, from AIRIS campaign tracking.

Example: "wp_1024"

campaign_aa_crtv_id

string

Appier ad creative ID of the visit, from AIRIS campaign tracking.

Example: "1234567"

`ec_account_link`

DefaultBillable

Generated by BotBonnie when the user links their e-commerce or CRM member account. The member's details, such as name, email address, phone number, and membership tier, are also saved to the user's profile.

Property

Type

Description

ec_account_linked

string

ID of the linked e-commerce member account.

Example: "EC-MEMBER-ID-123"

`ec_coupon_received`

DefaultBillable

Generated by BotBonnie when the user receives a coupon.

Property

Type

Description

coupon_title

string

Name of the coupon.

Example: "Spring sale coupon"

coupon_code

string

Coupon code.

Example: "SPRING-1234"

promotion_id

string

ID of the promotion the coupon belongs to.

Example: "PROMO-ID-123"

promotion_type

string

Type of promotion.

Example: "draw"

user_id

string

ID of the user's e-commerce member account.

Example: "member_10023"

expired_date

string

Expiration date of the coupon.

Example: "Never expires"

`ec_credit_received`

DefaultBillable

Generated by BotBonnie when the user receives store credit.

Property

Type

Description

value

integer

Amount of credit received.

Example: 100

credit_earned

integer

Change in the user's credit.

Example: 100

remaining

integer

The user's credit balance after the change.

Example: 500

reason

string

Reason for the change.

Example: "Refund to credit"

expired_date

string

Expiration date of the credit.

Example: "2026/12/31"

user_id

string

ID of the user's e-commerce member account.

Example: "member_10023"

`ec_credit_used`

DefaultBillable

Generated by BotBonnie when the user uses store credit.

Property

Type

Description

value

integer

Amount of credit used.

Example: 79

credit_earned

integer

Change in the user's credit. Negative when credit is used.

Example: -79

remaining

integer

The user's credit balance after the change.

Example: 421

reason

string

Reason for the change.

Example: "Order payment"

expired_date

string

Expiration date of the credit.

Example: "Never expires"

user_id

string

ID of the user's e-commerce member account.

Example: "member_10023"

`ec_membership_tier_updated`

DefaultBillable

Generated by BotBonnie when the user's membership tier changes. The new tier, with its ID, name, and expiration date, is saved to the ec_membership_tier user property.

No event-specific properties.

`ec_order_placed`

DefaultBillable

Generated by BotBonnie when the user places an order.

Property

Type

Description

order_id

string

ID of the order.

Example: "ORD-20240930-001"

order_number

string

Order number shown to the user.

Example: "20260210023946626"

order_payment

string

Order total, with its currency.

Example: "1599 TWD"

amount

number

Order total.

Example: 1599

currency

string

Currency of the order, as a three-letter ISO 4217 code.

Example: "TWD"

payment_type

string

Payment method.

Example: "Credit card"

delivery

string

Delivery method.

Example: "Home delivery"

purchased_products

object[]

Products in the order, each with its ID (product_id) and quantity (quantity).

Example: [{"product_id": "SKU-10023", "quantity": 1}]

user_id

string

ID of the user's e-commerce member account.

Example: "member_10023"

`ec_order_refunded`

DefaultBillable

Generated by BotBonnie when an order is refunded.

Property

Type

Description

order_id

string

ID of the order.

Example: "ORD-20240930-001"

order_number

string

Order number shown to the user.

Example: "20260210023946626"

refund_amount

string

Refunded amount, with its currency.

Example: "1599 TWD"

amount

number

Refunded amount.

Example: 1599

currency

string

Currency of the refund, as a three-letter ISO 4217 code.

Example: "TWD"

payment_type

string

Payment method.

Example: "Credit card"

cancel_reason

string

Reason the order was canceled.

Example: "Changed my mind"

`ec_order_status_changed`

DefaultBillable

Generated by BotBonnie when the status of an order changes.

Property

Type

Description

order_id

string

ID of the order.

Example: "ORD-20240930-001"

current_status

string

New status of the order.

Example: "confirmed"

status_changed_at

string

When the status changed, in ISO 8601 format.

Example: "2026-02-10T05:49:20.645Z"

`ec_point_received`

DefaultBillable

Generated by BotBonnie when the user earns loyalty points.

Property

Type

Description

value

integer

Number of points earned.

Example: 150

point_earned

integer

Change in the user's points.

Example: 150

remaining

integer

The user's point balance after the change.

Example: 1200

reason

string

Reason for the change.

Example: "Purchase reward"

expired_date

string

Expiration date of the points.

Example: "2027/09/16"

user_id

string

ID of the user's e-commerce member account.

Example: "member_10023"

`ec_point_used`

DefaultBillable

Generated by BotBonnie when the user uses loyalty points.

Property

Type

Description

value

integer

Number of points used.

Example: 150

point_earned

integer

Change in the user's points. Negative when points are used.

Example: -150

remaining

integer

The user's point balance after the change.

Example: 1050

reason

string

Reason for the change.

Example: "Order discount"

expired_date

string

Expiration date of the points.

Example: "Never expires"

user_id

string

ID of the user's e-commerce member account.

Example: "member_10023"

`ec_shipment_updated`

DefaultBillable

Generated by BotBonnie when an order is shipped or delivered.

Property

Type

Description

status

string

Shipment status: "shipped" or "delivered".

Example: "shipped"

order_id

string

ID of the order.

Example: "ORD-20240930-001"

order_number

string

Order number shown to the user.

Example: "20260210023946626"

order_payment

string

Order total, with its currency.

Example: "1599 TWD"

payment_type

string

Payment method.

Example: "Credit card"

delivery

string

Delivery method.

Example: "Home delivery"

tracking_number

string

Shipment tracking number.

Example: "TRACK-123456"

delivery_date

string

Date the order was delivered. Sent only when status is "delivered".

Example: "2026/02/10"

`first_app_launched`

DefaultBillable

Logged once, the first time the app is launched after the SDK is installed.

No event-specific properties.

`follow`

DefaultBillable

Generated by BotBonnie when the user follows your official account.

No event-specific properties.

`geofence_enter`

Default

Logged when the device enters an Appier geofence (a configured location area). Only logged when geofencing is enabled for your account.

Property

Type

Description

geofence_id

string

ID of the geofence.

Example: "1024"

geofence_name

string

Name of the geofence.

Example: "Taipei Main Station"

geofence_latitude

float

Latitude of the geofence center.

Example: 25.0478

geofence_longitude

float

Longitude of the geofence center.

Example: 121.5170

geofence_radius

float

Radius of the geofence, in meters.

Example: 200

geofence_config

string

Geofence settings as id|latitude|longitude|radius.

Example: "1024|25.0478|121.5170|200"

latitude

float

Latitude of the device at the time of the transition.

Example: 25.0480

longitude

float

Longitude of the device at the time of the transition.

Example: 121.5172

altitude

float

Altitude of the device, if available.

Example: 12.5

accuracy

float

Horizontal accuracy of the device location, in meters, if available.

Example: 15.0

speed

float

Speed of the device, if available.

Example: 0.0

provider

string

Location provider that reported the position (Android).

Example: "fused"

timestamp

integer

Time of the transition, in epoch seconds.

Example: 1727671200

`geofence_exit`

Default

Logged when the device leaves an Appier geofence. Only logged when geofencing is enabled for your account.

Property

Type

Description

geofence_id

string

ID of the geofence.

Example: "1024"

geofence_name

string

Name of the geofence.

Example: "Taipei Main Station"

geofence_latitude

float

Latitude of the geofence center.

Example: 25.0478

geofence_longitude

float

Longitude of the geofence center.

Example: 121.5170

geofence_radius

float

Radius of the geofence, in meters.

Example: 200

geofence_config

string

Geofence settings as id|latitude|longitude|radius.

Example: "1024|25.0478|121.5170|200"

latitude

float

Latitude of the device at the time of the transition.

Example: 25.0480

longitude

float

Longitude of the device at the time of the transition.

Example: 121.5172

altitude

float

Altitude of the device, if available.

Example: 12.5

accuracy

float

Horizontal accuracy of the device location, in meters, if available.

Example: 15.0

speed

float

Speed of the device, if available.

Example: 0.0

provider

string

Location provider that reported the position (Android).

Example: "fused"

timestamp

integer

Time of the transition, in epoch seconds.

Example: 1727671200

`geofence_register_failed`

Default

Logged when the SDK fails to register a geofence for monitoring. Only logged when geofencing is enabled for your account.

Property

Type

Description

geofence_id

string

ID of the geofence.

Example: "1024"

geofence_name

string

Name of the geofence.

Example: "Taipei Main Station"

error

string

Error message explaining why registration failed.

Example: "Geofence service is not available now"

geofence_latitude

float

Latitude of the geofence center (iOS).

Example: 25.0478

geofence_longitude

float

Longitude of the geofence center (iOS).

Example: 121.5170

geofence_radius

float

Radius of the geofence, in meters (iOS).

Example: 200

geofence_config

string

Geofence settings as id|latitude|longitude|radius (iOS).

Example: "1024|25.0478|121.5170|200"

timestamp

integer

Time of the failure, in epoch seconds (iOS).

Example: 1727671200

`geofence_updated`

Default

Logged when the SDK has finished registering or updating the geofences to monitor on the device. Only logged when geofencing is enabled for your account.

No event-specific properties.

`incognito_browsing`

Default

Logged when the SDK detects that the user is browsing in a private or incognito window.

No event-specific properties.

`interest_tagging`

Default

Generated by AIRIS when it tags the user with an interest keyword. AIRIS also adds the AIRIS system event properties.

Property

Type

Description

keyword

string

Interest keyword the user was tagged with.

Example: "skincare"

`journey_map_entry`

DefaultBillable

Logged when a user enters a journey map.

Property

Type

Description

timestamp

integer

Time of the transition, in epoch milliseconds.

Example: 1727671200000

journey_map_id

string

ID of the journey map, in the form journeymap-<id>.

Example: "journeymap-1234"

journey_node_id

string

ID of the first node the user entered.

Example: "node-5"

journey_map_version

string

Version of the journey map the user was in. Empty when the version is unknown.

Example: "3"

`journey_map_exit`

Default

Logged when a user exits a journey map, with the node they left from and, when it applies, the path they took out of that node.

Property

Type

Description

timestamp

integer

Time of the transition, in epoch milliseconds.

Example: 1727671200000

journey_map_id

string

ID of the journey map, in the form journeymap-<id>.

Example: "journeymap-1234"

journey_node_id

string

ID of the node the user exited from.

Example: "node-5"

journey_map_version

string

Version of the journey map the user was in. Empty when the version is unknown.

Example: "3"

journey_map_split_path_type

string

Type of path taken out of the exit node.

Example: "clicked"

journey_map_split_path_id

string

ID of the path taken out of the exit node, when it has one.

Example: "path-2"

`lead_initiated`

System-definedBillable

Log when the user first interacts meaningfully with a lead or consultation form. Don't log it on page load. Website only.

Property

Type

Description

form_id

string

Unique ID of the form.

Example: "CONSULTATION-FORM"

form_name

string

Display name of the form.

Example: "Book a Consultation"

service_id

string

ID of the service or offering the inquiry is for.

Example: "SERVICE-123"

service_name

string

Name of the service or offering the inquiry is for.

Example: "Financial Planning Consultation"

Event logging sample

appier('event', 'lead_initiated', {
  form_id: 'CONSULTATION-FORM',
  form_name: 'Book a Consultation',
  service_id: 'SERVICE-123',
  service_name: 'Financial Planning Consultation'
});

`lead_submitted`

System-definedBillable

Log when the website confirms that a lead or inquiry was submitted. Use it as the primary lead conversion. Website only.

Property

Type

Description

lead_id

string

Unique ID of the submitted lead.

Example: "LEAD-123"

form_id

string

Unique ID of the form.

Example: "CONSULTATION-FORM"

form_name

string

Display name of the form.

Example: "Book a Consultation"

service_id

string

ID of the service or offering the inquiry is for.

Example: "SERVICE-123"

service_name

string

Name of the service or offering the inquiry is for.

Example: "Financial Planning Consultation"

lead_source

string

Source of the lead, as defined by your business.

Example: "website_consultation_form"

user_id

string

User ID assigned by your business. Include it when available and permitted, to help Appier recognize the user.

Example: "member_10023"

email

string

Email address of the user. Include it when available and permitted, to help Appier recognize the user.

Example: "[email protected]"

phone_no

string

Phone number of the user, including the country code. Include it when available and permitted, to help Appier recognize the user.

Example: "+886912345678"

Event logging sample

appier('event', 'lead_submitted', {
  lead_id: 'LEAD-123',
  form_id: 'CONSULTATION-FORM',
  form_name: 'Book a Consultation',
  service_id: 'SERVICE-123',
  service_name: 'Financial Planning Consultation',
  lead_source: 'website_consultation_form',
  user_id: 'member_10023',
  email: '[email protected]',
  phone_no: '+886912345678'
});

`login`

System-definedBillable

Log after your website or app confirms the user's sign-in, not when the login page loads or the login button is clicked.

No event-specific properties.

Event logging sample

// Call after your website's own sign-in succeeds.
// Saves user_id to the user's profile, then sends the login event.
appier('login', 'user_id', 'member_10023');

QGSdk.getSharedInstance().logEvent("login")

QG.getInstance(context).logEvent("login")

`mobile_screen_viewed`

System-definedBillable

Log when your app shows a screen, by calling AiDeal's startLogging method with the screen's page types. The SDK logs this event with the page types you pass.

Property

Type

Description

screen_types

string[]

Page types of the screen: "top", "search", "detail_search", "category", "item_group", "item", "registration_form", "registration", "login", "mypage", "cart", "cart_form", "conversion", or a custom page type.

Example: ["item"]

Event logging sample

// In the screen's view controller
let attributes = AIDPageAttributes.Builder()
    .pageType(.item)
    .build()
AppierSDK.AiDeal.startLogging(self, attributes: attributes)

// In the screen's Activity
val attributes = Attributes.Builder()
    .pageType(PageType.ITEM)
    .build()
Appier.AiDeal.startLogging(this, attributes)

`notification_browsed`

Default

Logged when the user browses the items of a carousel or slider push, by tapping next or previous or by swiping.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

`notification_clicked`

DefaultBillableMAU billable

Logged when the user clicks a campaign message, taps an app or web push notification, opens a tracked link in an email, or lands on the website or app from a LINE or ATM campaign link. Not logged for in-app, in-web, and MMS campaigns.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

actionid

string

For app push (Android): ID of the tapped action button, or the position of the tapped carousel or slider item (100 for the header).

Example: "btn_view"

qgtag

string

For app push (Android): tag of the tapped carousel or slider item.

Example: "item_2"

product_line

string

For web clicks from an ATM campaign link: the product line of the campaign that sent the link.

Example: "aiqua"

ts

integer

For email link clicks: time of the click, in epoch seconds.

Example: 1727671200

url

string

For email link clicks: the original link the user clicked.

Example: "https://www.example.com/sale"

`notification_delivered`

Default

Logged when the sending vendor reports that a campaign message was delivered to the user. Covers SMS, MMS, Kakao, email, and LINE. For LINE, logged as soon as the message is sent.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

ts

integer

Time the delivery was reported, in epoch seconds.

Example: 1727671200

msgid

string

Message ID from the vendor's delivery report.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

vender

string

Vendor that reported the delivery, for SMS and MMS: mitake (SMS) or mmsmitake (MMS).

Example: "mitake"

vendor

string

Vendor that reported the delivery, for Kakao: kakaoinfobip. Kakao delivery reports use this key instead of vender.

Example: "kakaoinfobip"

msgcount

integer

Number of SMS credits the message used, from Vonage delivery reports.

Example: 1

ip

string

For Sendgrid email: IP address reported in Sendgrid's delivery webhook.

Example: "167.89.0.10"

`notification_displayed`

Default

Logged when a push notification is shown on the device. On iOS it is logged by the Notification Service Extension.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

`notification_error`

Default

Logged when a campaign message sent through ESS Sender fails to reach the user, currently for Kakao Moment campaigns. The event carries no error details.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

ts

integer

Time the failure was reported, in epoch seconds.

Example: 1727671200

`notification_received`

Default

Logged when a campaign message reaches the user: an app or web push arrives on the device, or the email service provider reports the email as sent or delivered.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

device_time

integer

Time the push arrived on the device, in epoch seconds (Android).

Example: 1727671200

in_blackout_window

string

Whether the push arrived during the blackout window: "true", "false", "unspecified", or "invalid" (Android).

Example: "false"

expired

string

Whether the push had already expired when it arrived: "true", "false", "unspecified", or "invalid" (Android).

Example: "false"

msgid

string

Message ID from the email service provider (email only).

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time the email service provider reported the email, in epoch seconds (email only).

Example: 1727671200

`notification_sent`

DefaultMAU billable

Logged when a campaign message is accepted by the sending vendor for a user. Covers app push (FCM, APNs), web push, SMS, MMS, Kakao, email, and LINE. Not logged for in-app and in-web campaigns.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

ts

integer

Time the vendor accepted the message, in epoch seconds.

Example: 1727671200

vender

string

Sending channel or vendor: web, fcm, apns, mitake (SMS), mmsmitake (MMS) or kakaoinfobip. Sent together with vendortrackid.

Example: "fcm"

vendortrackid

string

Message ID returned by the vendor. Sent only when the vendor returns one.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

msgcount

integer

Number of credits the message used: SMS segments or MMS credits. Sent only for SMS and MMS.

Example: 1

`notification_targeted`

Default

Logged when a user is selected as a recipient of an A/B experiment campaign, including users in the control group, who are not sent the message.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

ts

integer

Time the user was targeted, in epoch seconds.

Example: 1727671200

`outgoing`

DefaultBillable

Generated by AIRIS when the user clicks a link from your website to another website. Outgoing link tracking is on by default. AIRIS also adds the AIRIS system event properties.

Property

Type

Description

url

string

URL of the external link the user clicked.

Example: "https://partner.example.org/"

`page_viewed`

DefaultBillableMAU billable

Logged on every page load of the website, with the page URL, the referrer, and any UTM parameters from the URL.

Property

Type

Description

url

string

Full URL of the viewed page.

Example: "https://www.example.com/products/123?utm_source=newsletter"

referrer

string

URL of the page the user came from (document.referrer). Sent only when the browser provides one.

Example: "https://www.google.com/"

qg_seg

string

Value of the qg_seg query parameter in the page URL. Sent only when present.

Example: "vip"

utm_source

string

UTM source from the URL of the viewed page.

Example: "newsletter"

utm_medium

string

UTM medium from the URL of the viewed page.

Example: "email"

utm_campaign

string

UTM campaign name from the URL of the viewed page.

Example: "spring_sale"

utm_term

string

UTM term (paid search keyword) from the URL of the viewed page.

Example: "running shoes"

utm_content

string

UTM content, used to tell apart ads or links in the same campaign, from the URL of the viewed page.

Example: "banner_a"

utm_id

string

UTM campaign ID from the URL of the viewed page.

Example: "cmp_2024_01"

utm_aa_crtv_id

string

Appier ad creative ID (utm_aa_crtv_id) from the URL of the viewed page.

Example: "1234567"

Event logging sample

// Single-page applications only: the SDK logs page_viewed automatically on other websites.
// Log it manually each time the page's URL changes.
appier('event', 'page_viewed', { url: window.location.href });

`payment_info_added`

System-definedBillable

Log when the user adds payment information, such as a credit card or PayPal account, to their account.

Property

Type

Description

user_id

string

The identifier of the user who initiated the event.

Example: "member_10023"

Event logging sample

appier('event', 'payment_info_added', {
  user_id: 'member_10023'
});

var properties: [String: Any] = [:]
properties["user_id"] = "member_10023"
QGSdk.getSharedInstance().logEvent("payment_info_added",
                                   withParameters: properties)

try {
    val properties = JSONObject()
    properties.put("user_id", "member_10023")
    QG.getInstance(context).logEvent("payment_info_added", properties)
} catch (e: JSONException) {
    // Handle the exception
}

`prediction_score_update`

Default

Logged when AiDeal updates its prediction scores for the user, such as conversion, price sensitivity, and uplift scores. Used in journey map conditions.

Property

Type

Description

conversion_score

float

Predicted likelihood that the user converts.

Example: 0.82

price_sensitivity_score

float

Predicted sensitivity of the user to price.

Example: 0.35

uplift_score

float

Predicted uplift from targeting the user with a campaign.

Example: 0.12

`product_added_to_cart`

System-definedBillable

Log when the user adds a product to their shopping cart. Log one event per product.

Property

Type

Description

product_id

string

The identifier of the product this event relates to.

Example: "SKU-10023"

product_price

float

The product price.

Example: 799.99

product_name

string

The product name.

Example: "Running Shoes X1"

product_image_url

string

The product image's URL.

Example: "https://cdn.example.com/img/sku-10023.jpg"

product_url

string

The product page's URL.

Example: "https://www.example.com/products/sku-10023"

user_id

string

The identifier of the user who initiated the event.

Example: "member_10023"

product_category

string

Category of the product. A comma-separated list when the product has several categories.

Example: "Shoes,Running"

currency

string

Currency of the prices in this event, as a three-letter ISO 4217 code.

Example: "TWD"

Event logging sample

appier('event', 'product_added_to_cart', {
  product_id: 'SKU-10023',
  product_price: 799.99,
  product_name: 'Running Shoes X1',
  product_image_url: 'https://cdn.example.com/img/sku-10023.jpg',
  product_url: 'https://www.example.com/products/sku-10023',
  user_id: 'member_10023',
  product_category: 'Shoes,Running',
  currency: 'TWD'
});

var properties: [String: Any] = [:]
properties["product_id"] = "SKU-10023"
properties["product_price"] = 799.99
properties["product_name"] = "Running Shoes X1"
properties["product_image_url"] = "https://cdn.example.com/img/sku-10023.jpg"
properties["product_url"] = "https://www.example.com/products/sku-10023"
properties["user_id"] = "member_10023"
properties["product_category"] = "Shoes,Running"
properties["currency"] = "TWD"
QGSdk.getSharedInstance().logEvent("product_added_to_cart",
                                   withParameters: properties)

try {
    val properties = JSONObject()
    properties.put("product_id", "SKU-10023")
    properties.put("product_price", 799.99)
    properties.put("product_name", "Running Shoes X1")
    properties.put("product_image_url", "https://cdn.example.com/img/sku-10023.jpg")
    properties.put("product_url", "https://www.example.com/products/sku-10023")
    properties.put("user_id", "member_10023")
    properties.put("product_category", "Shoes,Running")
    properties.put("currency", "TWD")
    QG.getInstance(context).logEvent("product_added_to_cart", properties)
} catch (e: JSONException) {
    // Handle the exception
}

`product_added_to_wishlist`

System-definedBillable

Log when the user adds a product to their wishlist or favorites.

Property

Type

Description

product_id

string

The identifier of the product this event relates to.

Example: "SKU-10023"

product_price

float

The product price.

Example: 799.99

product_name

string

The product name.

Example: "Running Shoes X1"

product_image_url

string

The product image's URL.

Example: "https://cdn.example.com/img/sku-10023.jpg"

product_url

string

The product page's URL.

Example: "https://www.example.com/products/sku-10023"

user_id

string

The identifier of the user who initiated the event.

Example: "member_10023"

product_category

string

Category of the product. A comma-separated list when the product has several categories.

Example: "Shoes,Running"

Event logging sample

appier('event', 'product_added_to_wishlist', {
  product_id: 'SKU-10023',
  product_price: 799.99,
  product_name: 'Running Shoes X1',
  product_image_url: 'https://cdn.example.com/img/sku-10023.jpg',
  product_url: 'https://www.example.com/products/sku-10023',
  user_id: 'member_10023',
  product_category: 'Shoes,Running'
});

var properties: [String: Any] = [:]
properties["product_id"] = "SKU-10023"
properties["product_price"] = 799.99
properties["product_name"] = "Running Shoes X1"
properties["product_image_url"] = "https://cdn.example.com/img/sku-10023.jpg"
properties["product_url"] = "https://www.example.com/products/sku-10023"
properties["user_id"] = "member_10023"
properties["product_category"] = "Shoes,Running"
QGSdk.getSharedInstance().logEvent("product_added_to_wishlist",
                                   withParameters: properties)

try {
    val properties = JSONObject()
    properties.put("product_id", "SKU-10023")
    properties.put("product_price", 799.99)
    properties.put("product_name", "Running Shoes X1")
    properties.put("product_image_url", "https://cdn.example.com/img/sku-10023.jpg")
    properties.put("product_url", "https://www.example.com/products/sku-10023")
    properties.put("user_id", "member_10023")
    properties.put("product_category", "Shoes,Running")
    QG.getInstance(context).logEvent("product_added_to_wishlist", properties)
} catch (e: JSONException) {
    // Handle the exception
}

`product_purchased`

System-definedBillable

Log once for each product in a completed order, along with one checkout_completed event for the order. Include the product's value as valueToSum. Don't use it as the primary order conversion event, since one order can produce several of these events. Use checkout_completed instead.

Property

Type

Description

order_idRequired

string

The unique identifier for the order.

Example: "ORD-20240930-001"

product_idRequired

string

The identifier of the product this event relates to.

Example: "SKU-10023"

product_price

float

The product price.

Example: 799.99

product_name

string

The product name.

Example: "Running Shoes X1"

product_image_url

string

The product image's URL.

Example: "https://cdn.example.com/img/sku-10023.jpg"

product_url

string

The product page's URL.

Example: "https://www.example.com/products/sku-10023"

product_category

string

Category of the product. A comma-separated list when the product has several categories.

Example: "Shoes,Running"

product_quantity

float

Number of units of the product.

Example: 2

total_price

float

Total price of this line or order (price × quantity).

Example: 1599.98

user_id

string

The identifier of the user who initiated the event.

Example: "member_10023"

currency

string

Currency of the prices in this event, as a three-letter ISO 4217 code.

Example: "TWD"

Event logging sample

appier('event', 'product_purchased', {
  order_id: 'ORD-20240930-001',
  product_id: 'SKU-10023',
  product_price: 799.99,
  product_name: 'Running Shoes X1',
  product_image_url: 'https://cdn.example.com/img/sku-10023.jpg',
  product_url: 'https://www.example.com/products/sku-10023',
  product_category: 'Shoes,Running',
  product_quantity: 2,
  total_price: 1599.98,
  user_id: 'member_10023',
  currency: 'TWD'
}, 1599.98);

var properties: [String: Any] = [:]
properties["order_id"] = "ORD-20240930-001"
properties["product_id"] = "SKU-10023"
properties["product_price"] = 799.99
properties["product_name"] = "Running Shoes X1"
properties["product_image_url"] = "https://cdn.example.com/img/sku-10023.jpg"
properties["product_url"] = "https://www.example.com/products/sku-10023"
properties["product_category"] = "Shoes,Running"
properties["product_quantity"] = 2.0
properties["total_price"] = 1599.98
properties["user_id"] = "member_10023"
properties["currency"] = "TWD"
QGSdk.getSharedInstance().logEvent("product_purchased",
                                   withParameters: properties,
                                   withValueToSum: 1599.98)

try {
    val properties = JSONObject()
    properties.put("order_id", "ORD-20240930-001")
    properties.put("product_id", "SKU-10023")
    properties.put("product_price", 799.99)
    properties.put("product_name", "Running Shoes X1")
    properties.put("product_image_url", "https://cdn.example.com/img/sku-10023.jpg")
    properties.put("product_url", "https://www.example.com/products/sku-10023")
    properties.put("product_category", "Shoes,Running")
    properties.put("product_quantity", 2.0)
    properties.put("total_price", 1599.98)
    properties.put("user_id", "member_10023")
    properties.put("currency", "TWD")
    QG.getInstance(context).logEvent("product_purchased", properties, 1599.98)
} catch (e: JSONException) {
    // Handle the exception
}

`product_removed_from_cart`

System-definedBillable

Log when the user removes a product from their shopping cart. Log one event per product.

Property

Type

Description

product_id

string

The identifier of the product this event relates to.

Example: "SKU-10023"

product_price

float

The product price.

Example: 799.99

product_name

string

The product name.

Example: "Running Shoes X1"

product_image_url

string

The product image's URL.

Example: "https://cdn.example.com/img/sku-10023.jpg"

product_url

string

The product page's URL.

Example: "https://www.example.com/products/sku-10023"

user_id

string

The identifier of the user who initiated the event.

Example: "member_10023"

Event logging sample

appier('event', 'product_removed_from_cart', {
  product_id: 'SKU-10023',
  product_price: 799.99,
  product_name: 'Running Shoes X1',
  product_image_url: 'https://cdn.example.com/img/sku-10023.jpg',
  product_url: 'https://www.example.com/products/sku-10023',
  user_id: 'member_10023'
});

var properties: [String: Any] = [:]
properties["product_id"] = "SKU-10023"
properties["product_price"] = 799.99
properties["product_name"] = "Running Shoes X1"
properties["product_image_url"] = "https://cdn.example.com/img/sku-10023.jpg"
properties["product_url"] = "https://www.example.com/products/sku-10023"
properties["user_id"] = "member_10023"
QGSdk.getSharedInstance().logEvent("product_removed_from_cart",
                                   withParameters: properties)

try {
    val properties = JSONObject()
    properties.put("product_id", "SKU-10023")
    properties.put("product_price", 799.99)
    properties.put("product_name", "Running Shoes X1")
    properties.put("product_image_url", "https://cdn.example.com/img/sku-10023.jpg")
    properties.put("product_url", "https://www.example.com/products/sku-10023")
    properties.put("user_id", "member_10023")
    QG.getInstance(context).logEvent("product_removed_from_cart", properties)
} catch (e: JSONException) {
    // Handle the exception
}

`product_removed_from_wishlist`

System-definedBillable

Log when the user removes a product from their wishlist or favorites.

Property

Type

Description

product_id

string

The identifier of the product this event relates to.

Example: "SKU-10023"

product_price

float

The product price.

Example: 799.99

product_name

string

The product name.

Example: "Running Shoes X1"

product_image_url

string

The product image's URL.

Example: "https://cdn.example.com/img/sku-10023.jpg"

product_url

string

The product page's URL.

Example: "https://www.example.com/products/sku-10023"

user_id

string

The identifier of the user who initiated the event.

Example: "member_10023"

Event logging sample

appier('event', 'product_removed_from_wishlist', {
  product_id: 'SKU-10023',
  product_price: 799.99,
  product_name: 'Running Shoes X1',
  product_image_url: 'https://cdn.example.com/img/sku-10023.jpg',
  product_url: 'https://www.example.com/products/sku-10023',
  user_id: 'member_10023'
});

var properties: [String: Any] = [:]
properties["product_id"] = "SKU-10023"
properties["product_price"] = 799.99
properties["product_name"] = "Running Shoes X1"
properties["product_image_url"] = "https://cdn.example.com/img/sku-10023.jpg"
properties["product_url"] = "https://www.example.com/products/sku-10023"
properties["user_id"] = "member_10023"
QGSdk.getSharedInstance().logEvent("product_removed_from_wishlist",
                                   withParameters: properties)

try {
    val properties = JSONObject()
    properties.put("product_id", "SKU-10023")
    properties.put("product_price", 799.99)
    properties.put("product_name", "Running Shoes X1")
    properties.put("product_image_url", "https://cdn.example.com/img/sku-10023.jpg")
    properties.put("product_url", "https://www.example.com/products/sku-10023")
    properties.put("user_id", "member_10023")
    QG.getInstance(context).logEvent("product_removed_from_wishlist", properties)
} catch (e: JSONException) {
    // Handle the exception
}

`product_viewed`

System-definedBillable

Log when the user views a product page or product details. On product pages it can replace page_viewed.

Property

Type

Description

product_id

string

The identifier of the product this event relates to.

Example: "SKU-10023"

product_price

float

The product price.

Example: 799.99

product_name

string

The product name.

Example: "Running Shoes X1"

product_image_url

string

The product image's URL.

Example: "https://cdn.example.com/img/sku-10023.jpg"

product_url

string

The product page's URL.

Example: "https://www.example.com/products/sku-10023"

user_id

string

The identifier of the user who initiated the event.

Example: "member_10023"

product_category

string

Category of the product. A comma-separated list when the product has several categories.

Example: "Shoes,Running"

currency

string

Currency of the prices in this event, as a three-letter ISO 4217 code.

Example: "TWD"

Event logging sample

appier('event', 'product_viewed', {
  product_id: 'SKU-10023',
  product_price: 799.99,
  product_name: 'Running Shoes X1',
  product_image_url: 'https://cdn.example.com/img/sku-10023.jpg',
  product_url: 'https://www.example.com/products/sku-10023',
  user_id: 'member_10023',
  product_category: 'Shoes,Running',
  currency: 'TWD'
});

var properties: [String: Any] = [:]
properties["product_id"] = "SKU-10023"
properties["product_price"] = 799.99
properties["product_name"] = "Running Shoes X1"
properties["product_image_url"] = "https://cdn.example.com/img/sku-10023.jpg"
properties["product_url"] = "https://www.example.com/products/sku-10023"
properties["user_id"] = "member_10023"
properties["product_category"] = "Shoes,Running"
properties["currency"] = "TWD"
QGSdk.getSharedInstance().logEvent("product_viewed",
                                   withParameters: properties)

try {
    val properties = JSONObject()
    properties.put("product_id", "SKU-10023")
    properties.put("product_price", 799.99)
    properties.put("product_name", "Running Shoes X1")
    properties.put("product_image_url", "https://cdn.example.com/img/sku-10023.jpg")
    properties.put("product_url", "https://www.example.com/products/sku-10023")
    properties.put("user_id", "member_10023")
    properties.put("product_category", "Shoes,Running")
    properties.put("currency", "TWD")
    QG.getInstance(context).logEvent("product_viewed", properties)
} catch (e: JSONException) {
    // Handle the exception
}

`pv`

Default

Generated by AIRIS when the user loads a page on your website. AIRIS also adds the AIRIS system event properties.

Property

Type

Description

url

string

Full URL of the loaded page.

Example: "https://www.example.com/products/123"

uri

string

Path of the loaded page.

Example: "/products/123"

domain

string

Domain of the website.

Example: "www.example.com"

title

string

Title of the loaded page.

Example: "Running Shoes X1 | Example Store"

referrer

string

URL of the page the user came from.

Example: "https://www.google.com/"

returning

string

Whether the user has visited the website before.

Example: "true"

scroll_depth

float

How far the user scrolled down the page, as a fraction of the page height.

Example: 0.75

`qg_carousel_clicked`

DefaultBillable

Logged when the user taps an item in a carousel or slider push. The clicked item's content is sent with the event.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

title

string

Title of the clicked carousel item.

Example: "Spring sale starts now"

message

string

Message text of the clicked carousel item.

Example: "Up to 50% off this weekend"

image

string

Image URL of the clicked carousel item (Android).

Example: "https://cdn.example.com/img/banner.jpg"

imageurl

string

Image URL of the clicked carousel item (iOS).

Example: "https://cdn.example.com/img/banner.jpg"

body

string

Body text of the clicked carousel item (iOS).

Example: "Up to 50% off this weekend"

deeplink

string

Deep link of the clicked carousel item.

Example: "myapp://products/123"

`qg_carousel_dismissed`

DefaultBillable

Logged when the user dismisses a carousel or slider push with its dismiss action. iOS only.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

`qg_email_deferral`

Default

Logged when an email campaign message temporarily cannot be delivered and will be retried. Same meaning as qg_email_deferred, for emails sent through Mandrill.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the email service provider.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the event from the email service provider, in epoch seconds.

Example: 1727671200

`qg_email_deferred`

Default

Logged when an email campaign message temporarily cannot be delivered. The email service provider keeps retrying delivery for up to 72 hours.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the email service provider.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the event from the email service provider, in epoch seconds.

Example: 1727671200

`qg_email_group_resubed`

Default

Logged when the user resubscribes to an email subscription group they had left.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the email service provider.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the event from the email service provider, in epoch seconds.

Example: 1727671200

`qg_email_group_unsubed`

Default

Logged when the user unsubscribes from an email subscription group.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the email service provider.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the event from the email service provider, in epoch seconds.

Example: 1727671200

`qg_email_hard_bounced`

Default

Logged when an email campaign message hard-bounces, meaning delivery failed for a permanent reason such as the email address not existing. The user's email is also marked as hard-bounced in their profile.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the email service provider.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the event from the email service provider, in epoch seconds.

Example: 1727671200

`qg_email_opened`

DefaultBillableMAU billable

Logged when the user opens an email campaign message, as reported by the email service provider or by AIQUA's open-tracking pixel.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the email service provider. Not sent when the open is recorded by AIQUA's open-tracking pixel.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the open, from the email service provider or the open-tracking pixel, in epoch seconds.

Example: 1727671200

`qg_email_processed`

Default

Logged when the email service provider accepts an email campaign message and prepares to deliver it.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the email service provider.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the event from the email service provider, in epoch seconds.

Example: 1727671200

`qg_email_rejected`

Default

Logged when the email service provider rejects an email campaign message and does not send it, for example because the address is on its blocklist.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the email service provider.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the event from the email service provider, in epoch seconds.

Example: 1727671200

`qg_email_soft_bounced`

Default

Logged when an email campaign message soft-bounces, meaning delivery failed for a temporary reason such as a full mailbox. Emails dropped by Sendgrid are also logged as soft bounces.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the email service provider.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the event from the email service provider, in epoch seconds.

Example: 1727671200

`qg_email_spammed`

Default

Logged when the user reports an email campaign message as spam.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the email service provider.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the event from the email service provider, in epoch seconds.

Example: 1727671200

`qg_email_unsubed`

DefaultBillable

Logged when the user unsubscribes from email campaigns, through AIQUA's unsubscribe link or the email service provider's unsubscribe function.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

msgid

string

Message ID from the email service provider. Sent only when the unsubscribe is reported by the email service provider.

Example: "6c1f2a9e-3b7d-4e2a-9f10-5d8c7b6a4e21"

ts

integer

Time AIQUA received the unsubscribe, from the email service provider or AIQUA's unsubscribe link, in epoch seconds.

Example: 1727671200

`qg_inapp_clicked`

DefaultBillableMAU billable

Logged when the user taps a button or link in an in-app message, or a URL action in a Creative Studio in-app message.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

actionid

string

Position of the tapped button, starting at 1 (Android).

Example: "1"

qgtag

string

Tag of the tapped button (Android).

Example: "item_2"

calltoactiontext

string

Label of the tapped element in a Creative Studio in-app message.

Example: "Shop now"

`qg_inapp_closed`

DefaultBillable

Logged when the user closes an in-app message, or the message is closed by its own action (for example after a deep link opens).

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

`qg_inapp_displayed`

DefaultMAU billable

Logged when an in-app message is shown on the app screen. For Creative Studio in-app messages, it is logged when the content has finished loading.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

type

string

In-app message type (Android): "1" (floating), "2" (image), "3" (sized), "4" (inbox), "5" (HTML), or "6" (Creative Studio).

Example: "6"

`qg_inapp_failed`

Default

Logged when an in-app message cannot be shown, for example because its payload is invalid, its image or icon fails to download, or a Creative Studio message fails to load.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

reason

string

Why the message failed.

Example: "invalid_campaign_image"

msg

string

Error message (Android).

Example: "Failed to download campaign image"

cause

string

Underlying cause of the error (Android).

Example: "java.io.FileNotFoundException"

networktype

string

Network type of the device when the error happened (Android).

Example: "wifi"

giosgjsurl

string

URL of the Creative Studio script that failed to load (Android).

Example: "https://cdn.example.com/cstudio/interaction.js"

`qg_inapp_lead_gen`

DefaultBillable

Logged when the user submits the form in a Creative Studio in-app message. The submission time and campaign ID are also saved to the user's profile.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

leadtype

string

Type of lead form: creativeStudio.

Example: "creativeStudio"

`qg_inapp_toggled`

DefaultBillable

Logged when the user expands or collapses a floating or badge in-app message. Not supported for Creative Studio in-app messages.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

state

string

New state of the message: open or close.

Example: "open"

`qg_inweb_clicked`

DefaultBillableMAU billable

Logged when the user clicks a call-to-action in an in-web message.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

calltoactiontext

string

Text of the clicked call-to-action. Sent by in-web templates with labeled buttons, such as multiple-action, fixed-banner, and Creative Studio messages.

Example: "Shop now"

`qg_inweb_closed`

DefaultBillable

Logged when the user closes an in-web message.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

`qg_inweb_displayed`

DefaultMAU billable

Logged when an in-web message (a pop-up or banner on the website) is shown to the user.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

`qg_inweb_lead_gen`

DefaultBillable

Logged when the user submits the form in an in-web lead-generation or Creative Studio message. The submitted fields and submission details are also saved to the user's profile.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

leadtype

string

Type of lead form: lead (in-web lead form) or creativeStudio.

Example: "lead"

leadsubmitid

string

Unique ID of this form submission (in-web lead form only).

Example: "3f2b8c1e-7a4d-4b9e-8c21-0d5e6f7a8b90"

leadkeys

string[]

Names of the fields the user submitted (in-web lead form only).

Example: ["email", "phone"]

`qg_line_click`

DefaultBillableMAU billable

Logged when the user opens the website or app from a link in a LINE campaign message, identified by the _lnchid and _lnuid parameters in the link. A notification_clicked event is also logged for the campaign, and the user's LINE channel ID and LINE UID are saved to their profile.

Property

Type

Description

url

string

Full URL of the page or deep link the user opened from the LINE message.

Example: "https://www.example.com/sale?_lnchid=1656123456&_lnuid=U1234abcd"

utm_source

string

UTM source from the opened link.

Example: "newsletter"

utm_medium

string

UTM medium from the opened link.

Example: "email"

utm_campaign

string

UTM campaign name from the opened link.

Example: "spring_sale"

utm_term

string

UTM term from the opened link.

Example: "running shoes"

utm_content

string

UTM content from the opened link.

Example: "banner_a"

utm_id

string

UTM campaign ID from the opened link. Web SDK only.

Example: "cmp_2024_01"

utm_aa_crtv_id

string

Appier ad creative ID from the opened link. Web SDK only.

Example: "1234567"

`qg_notification_dismissed`

Default

Logged when the user taps the dismiss button on a carousel or slider push. Android only.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

actionid

integer

Position of the dismiss action; 100 when not set.

Example: 100

`qg_rich_push_opened`

DefaultBillable

Logged when the user expands a rich push notification (carousel or slider) to view its content. iOS only.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

`recommendation_clicked`

System-definedBillableMAU billable

Log when the user clicks a product recommended by an Appier recommendation scenario in your app, by calling the SDK's logRecommendationClicked method. On websites, and for recommendations in Creative Studio in-app messages, the SDK logs it automatically. Not attributed to campaigns.

Property

Type

Description

scenario_idRequired

string

ID of the recommendation scenario.

Example: "SCENARIO-ID-123"

model_idRequired

string

ID of the recommendation model that produced the results.

Example: "12345"

recommendation_idRequired

string

ID of this recommendation result, shared by its impression and click events.

Example: "73c01528-8a61-4181-a185-974d8e19286f"

product_idRequired

string

ID of the clicked product.

Example: "SKU-10023"

Event logging sample

QGSdk.getSharedInstance().logRecommendationClicked(withScenarioId: "SCENARIO-ID-123",
                                                   withModelId: "12345",
                                                   withProductId: "SKU-10023",
                                                   withRecommendationId: "73c01528-8a61-4181-a185-974d8e19286f")

QG.getInstance(context).logRecommendationClicked(
    "SCENARIO-ID-123",
    "12345",
    "SKU-10023",
    "73c01528-8a61-4181-a185-974d8e19286f"
)

`recommendation_impression`

DefaultMAU billable

Logged when an Appier recommendation scenario returns products to show the user, or returns no products for a no-recommendation experiment group. Not attributed to campaigns.

Property

Type

Description

scenario_id

string

ID of the recommendation scenario.

Example: "SCENARIO-ID-123"

model_id

string

ID of the recommendation model that produced the results.

Example: "12345"

recommendation_id

string

ID of this recommendation result, shared by its impression and click events.

Example: "73c01528-8a61-4181-a185-974d8e19286f"

`registration_completed`

System-definedBillable

Log when the user finishes registering an account.

Property

Type

Description

user_id

string

The identifier of the user who initiated the event.

Example: "member_10023"

Event logging sample

appier('event', 'registration_completed', {
  user_id: 'member_10023'
});

var properties: [String: Any] = [:]
properties["user_id"] = "member_10023"
QGSdk.getSharedInstance().logEvent("registration_completed",
                                   withParameters: properties)

try {
    val properties = JSONObject()
    properties.put("user_id", "member_10023")
    QG.getInstance(context).logEvent("registration_completed", properties)
} catch (e: JSONException) {
    // Handle the exception
}

`registration_initiated`

System-definedBillable

Log when the user starts registering an account.

No event-specific properties.

Event logging sample

appier('event', 'registration_initiated');

QGSdk.getSharedInstance().logEvent("registration_initiated")

QG.getInstance(context).logEvent("registration_initiated")

`remove_tag`

DefaultBillable

Generated by BotBonnie when a tag is removed from the user. The user's remaining tags are also saved to the bb_tag_ids and bb_tag_names user properties.

Property

Type

Description

bb_tag_ids

string[]

IDs of the removed tags.

Example: ["tag-AbC123xYz"]

bb_tag_names

string[]

Names of the removed tags.

Example: ["VIP"]

`searched`

System-definedBillable

Log when the user searches the website or app.

Property

Type

Description

searched_keyword

string

The term or keyword the user searched.

Example: "running shoes"

searched_keywords

string

Terms or keywords the user searched, as a comma-separated string.

Example: "running shoes,socks"

user_id

string

The identifier of the user who initiated the event.

Example: "member_10023"

Event logging sample

appier('event', 'searched', {
  searched_keyword: 'running shoes',
  searched_keywords: 'running shoes,socks',
  user_id: 'member_10023'
});

var properties: [String: Any] = [:]
properties["searched_keyword"] = "running shoes"
properties["searched_keywords"] = "running shoes,socks"
properties["user_id"] = "member_10023"
QGSdk.getSharedInstance().logEvent("searched",
                                   withParameters: properties)

try {
    val properties = JSONObject()
    properties.put("searched_keyword", "running shoes")
    properties.put("searched_keywords", "running shoes,socks")
    properties.put("user_id", "member_10023")
    QG.getInstance(context).logEvent("searched", properties)
} catch (e: JSONException) {
    // Handle the exception
}

`send`

DefaultBillableMAU billable

Generated by BotBonnie when the user sends a message to the bot, such as text, an image, or a sticker.

Property

Type

Description

type

string

Type of message: "text", "video", "audio", "image", "file", "location", or "sticker".

Example: "text"

`story_mention`

DefaultBillable

Generated by BotBonnie when the user mentions your account in a social media story, such as an Instagram story.

Property

Type

Description

story

object

The story that mentions your account: its media URL (source) and ID (id).

Example: {"source": "https://lookaside.fbsbx.com/ig_messaging_cdn/?asset_id=1234567890", "id": "1234567890"}

`subscribed_to_webpush`

DefaultBillable

Logged when the website's web push notification permission changes to "granted", for example when the user clicks Allow in the browser prompt. The Web SDK checks the permission when the prompt is answered and on each page load, so a change made in browser settings is logged on the user's next visit.

Property

Type

Description

url

string

Full URL of the page where the permission change was detected.

Example: "https://www.example.com/products/123"

referrer

string

URL of the page the user came from (document.referrer) when the permission change was detected. Sent only when the browser provides one.

Example: "https://www.google.com/"

`unfollow`

DefaultBillable

Generated by BotBonnie when the user unfollows your official account.

No event-specific properties.

`unsubscribed_to_webpush`

DefaultBillable

Logged when the website's web push notification permission changes to "denied", for example when the user clicks Block in the browser prompt or blocks notifications in browser settings. A permission reset to the default state (ask again) is not logged.

Property

Type

Description

url

string

Full URL of the page where the permission change was detected.

Example: "https://www.example.com/products/123"

referrer

string

URL of the page the user came from (document.referrer) when the permission change was detected. Sent only when the browser provides one.

Example: "https://www.google.com/"

`url_click`

DefaultBillableMAU billable

Generated by BotBonnie when the user clicks a link in a bot message.

Property

Type

Description

url

string

URL of the clicked link.

Example: "https://www.example.com/sale?utm_source=line"

value

string

ID of the bot message module that contains the link.

Example: "module-AbC123xYz"

`visited`

DefaultBillable

Logged on the user's first page load of the day on the website; at most once per day.

Property

Type

Description

url

string

Full URL of the page the user landed on for their first visit of the day.

Example: "https://www.example.com/?utm_source=newsletter"

utm_source

string

UTM source from the URL of the page the user landed on.

Example: "newsletter"

utm_medium

string

UTM medium from the URL of the page the user landed on.

Example: "email"

utm_campaign

string

UTM campaign name from the URL of the page the user landed on.

Example: "spring_sale"

utm_term

string

UTM term (paid search keyword) from the URL of the page the user landed on.

Example: "running shoes"

utm_content

string

UTM content, used to tell apart ads or links in the same campaign, from the URL of the page the user landed on.

Example: "banner_a"

utm_id

string

UTM campaign ID from the URL of the page the user landed on.

Example: "cmp_2024_01"

utm_aa_crtv_id

string

Appier ad creative ID (utm_aa_crtv_id) from the URL of the page the user landed on.

Example: "1234567"

Deprecated events

These events are no longer in use. They may still appear in your data when users have apps or websites with older SDK versions, but Appier features don't use them.

`aiq_cs_load_started`

Default

Logged when a Creative Studio in-app message starts loading its content. iOS only.

Property

Type

Description

notificationid

string

Campaign notification ID.

Example: "1900012345"

giosg_interaction_id

string

ID of the Creative Studio interaction being loaded.

Example: "6f1c2d3e4b5a"

type

integer

In-app message type; always 6 (Creative Studio).

Example: 6

`aiq_web_personalization_impression`

Default

Logged when a web personalization campaign replaces content on the website with personalized content.

Property

Type

Description

campaign_id

string

ID of the web personalization campaign.

Example: "wp_1024"

url

string

Full URL of the page where the personalized content was shown.

Example: "https://www.example.com/"

referrer

string

URL of the page the user came from (document.referrer).

Example: "https://www.google.com/"

`drip_notification_shown`

Default

Logged when a queued drip push is shown after the user deletes the previous notification of a drip campaign. Android only.

No event-specific properties.

`inapp_param_missing`

Default

Logged when an in-app campaign's trigger has parameter conditions but the triggering event has no parameters, so the campaign cannot be matched. Android only.

No event-specific properties.

`missing_endpoint`

Default

Logged when the app calls the recommendation API but no recommendation endpoint is configured for the app. iOS only.

Property

Type

Description

endpoint

string

Name of the missing endpoint: "recommendation".

Example: "recommendation"

api

string

Name of the SDK method that needed the endpoint.

Example: "getRecommendationWithScenarioId:"

`qg_exception`

Default

Logged when the Android SDK hits an internal error, for example a notification job fails to start, a notification sound fails to download, or campaign resources fail to load.

Property

Type

Description

msg

string

Error message.

Example: "Error in downloading notification sound"

cause

string

Underlying cause of the error, if known.

Example: "coerceIn"

networktype

string

Network type of the device when the error happened, or "none".

Example: "wifi"

filename

string

Source file that reported the error (sent by the in-app drag handler).

Example: "DraggableLayout"

density

float

Screen density of the device (sent by the in-app drag handler).

Example: 2.75

AIRIS system event properties

AIRIS adds these properties automatically to every event it tracks. They aren't repeated on each event card. Data types are shown as they appear in AIRIS.

Key

Display name

Data type

Description

~d

Domain

Text

The domain running the tracker script.

~i

Is First Event In Visit

Short Boolean

Whether this is the first event in the visit.

~o

Is Last Event In Visit

Short Boolean

Whether this is the last event in the visit.

is_first

Is First Event

Short Boolean

Whether this is the user's first event.

~c

Is Current Event

Short Boolean

Whether this is the most recent event in the active visit.

~n

Event Name

Text

The key of the event.

~a

Event Display Name

Text

The event's display name, as defined in the schema.

~p

Integration

Text

The library or integration used to track the event.

~q

App

Text

The Appier App ID.

~r

Platform

Text

The platform the event was tracked from, such as "web", "ios", or "android".

~s

Is HTTPS

Short Boolean

Whether the event was tracked securely over SSL/TLS.

~z

Event Type

The event type: Active, Passive, or System.

~u

Event Duration

Duration (Seconds)

The event's duration in seconds. AIRIS sets this automatically for page view events.

@time

Event Timestamp

Timestamp (Unix)

When the event took place.

~t

Triggerable

Short Boolean

Whether the event can cause a trigger to run.

campaign_name

Campaign Name

Text

The specific product promotion or strategic campaign, from utm_campaign.

campaign_source

Campaign Source

Text

The site that sent the traffic, from utm_source.

campaign_medium

Campaign Medium

Text

The type of link used, such as cost per click or email, from utm_medium.

campaign_content

Campaign Content

Text

What the user clicked to reach the site, from utm_content.

campaign_term

Campaign Term

Text

The search terms, from utm_term.

campaign_id

Campaign ID

Text

The campaign ID, from utm_id.