Analytics Events

Predefined event names.

Summary

An Event is an important occurrence in your app that you want to measure. You can report up to 500 different types of Events per app and you can associate up to 25 unique parameters with each Event type. Some common events are suggested below, but you may also choose to specify custom Event types that are associated with your specific app. Each event type is identified by a unique name. Event names can be up to 40 characters long, may only contain alphanumeric characters and underscores ("_"), and must start with an alphabetic character. The "firebase_" prefix is reserved and should not be used.

Variables

kEventAddPaymentInfo = "add_payment_info"
const char *const
Add Payment Info event.
kEventAddToCart = "add_to_cart"
const char *const
E-Commerce Add To Cart event.
kEventAddToWishlist = "add_to_wishlist"
const char *const
E-Commerce Add To Wishlist event.
kEventAppOpen = "app_open"
const char *const
App Open event.
kEventBeginCheckout = "begin_checkout"
const char *const
E-Commerce Begin Checkout event.
kEventCampaignDetails = "campaign_details"
const char *const
Campaign Detail event.
kEventCheckoutProgress = "checkout_progress"
const char *const
Checkout progress.
kEventEarnVirtualCurrency = "earn_virtual_currency"
const char *const
Earn Virtual Currency event.
kEventEcommercePurchase = "ecommerce_purchase"
const char *const
E-Commerce Purchase event.
kEventGenerateLead = "generate_lead"
const char *const
Generate Lead event.
kEventJoinGroup = "join_group"
const char *const
Join Group event.
kEventLevelUp = "level_up"
const char *const
Level Up event.
kEventLogin = "login"
const char *const
Login event.
kEventPostScore = "post_score"
const char *const
Post Score event.
kEventPresentOffer = "present_offer"
const char *const
Present Offer event.
kEventPurchaseRefund = "purchase_refund"
const char *const
E-Commerce Purchase Refund event.
kEventRemoveFromCart = "remove_from_cart"
const char *const
Remove from cart event.
kEventSearch = "search"
const char *const
Search event.
kEventSelectContent = "select_content"
const char *const
Select Content event.
kEventSetCheckoutOption = "set_checkout_option"
const char *const
Set checkout option.
kEventShare = "share"
const char *const
Share event.
kEventSignUp = "sign_up"
const char *const
Sign Up event.
kEventSpendVirtualCurrency = "spend_virtual_currency"
const char *const
Spend Virtual Currency event.
kEventTutorialBegin = "tutorial_begin"
const char *const
Tutorial Begin event.
kEventTutorialComplete = "tutorial_complete"
const char *const
Tutorial End event.
kEventUnlockAchievement = "unlock_achievement"
const char *const
Unlock Achievement event.
kEventViewItem = "view_item"
const char *const
View Item event.
kEventViewItemList = "view_item_list"
const char *const
View Item List event.
kEventViewSearchResults = "view_search_results"
const char *const
View Search Results event.

Variables

kEventAddPaymentInfo

const char *const kEventAddPaymentInfo = "add_payment_info"

Add Payment Info event.

This event signifies that a user has submitted their payment information to your app.

kEventAddToCart

const char *const kEventAddToCart = "add_to_cart"

E-Commerce Add To Cart event.

This event signifies that an item was added to a cart for purchase. Add this event to a funnel with kEventEcommercePurchase to gauge the effectiveness of your checParameter(kout, If you supply the kParameterValue parameter), you must also supply the kParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

  • kParameterQuantity (signed 64-bit integer)
  • kParameterItemID (string)
  • kParameterItemName (string)
  • kParameterItemCategory (string)
  • kParameterItemLocationID (string) (optional)
  • kParameterPrice (double) (optional)
  • kParameterCurrency (string) (optional)
  • kParameterValue (double) (optional)
  • kParameterOrigin (string) (optional)
  • kParameterDestination (string) (optional)
  • kParameterStartDate (string) (optional)
  • kParameterEndDate (string) (optional)

kEventAddToWishlist

const char *const kEventAddToWishlist = "add_to_wishlist"

E-Commerce Add To Wishlist event.

This event signifies that an item was added to a wishlist. Use this event to identify popular gift items in your app. Note: If you supply the kParameterValue parameter, you must also supply the kParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

  • kParameterQuantity (signed 64-bit integer)
  • kParameterItemID (string)
  • kParameterItemName (string)
  • kParameterItemCategory (string)
  • kParameterItemLocationID (string) (optional)
  • kParameterPrice (double) (optional)
  • kParameterCurrency (string) (optional)
  • kParameterValue (double) (optional)

kEventAppOpen

const char *const kEventAppOpen = "app_open"

App Open event.

By logging this event when an App is moved to the foreground, developers can understand how often users leave and return during the course of a Session. Although Sessions are automatically reported, this event can provide further clarification around the continuous engagement of app-users.

kEventBeginCheckout

const char *const kEventBeginCheckout = "begin_checkout"

E-Commerce Begin Checkout event.

This event signifies that a user has begun the process of checking out. Add this event to a funnel with your kEventEcommercePurchase event to gauge the effectiveness of your checkout process. Note: If you supply the kParameterValue parameter, you must also supply the kParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

  • kParameterValue (double) (optional)
  • kParameterCurrency (string) (optional)
  • kParameterTransactionID (string) (optional)
  • kParameterStartDate (string) (optional)
  • kParameterEndDate (string) (optional)
  • kParameterNumberOfNights (signed 64-bit integer) (optional) for hotel bookings
  • kParameterNumberOfRooms (signed 64-bit integer) (optional) for hotel bookings
  • kParameterNumberOfPassengers (signed 64-bit integer) (optional) for travel bookings
  • kParameterOrigin (string) (optional)
  • kParameterDestination (string) (optional)
  • kParameterTravelClass (string) (optional) for travel bookings

kEventCampaignDetails

const char *const kEventCampaignDetails = "campaign_details"

Campaign Detail event.

Log this event to supply the referral details of a re-engagement campaign. Note: you must supply at least one of the required parameters kParameterSource, kParameterMedium or kParameterCampaign. Params:

  • kParameterSource (string)
  • kParameterMedium (string)
  • kParameterCampaign (string)
  • kParameterTerm (string) (optional)
  • kParameterContent (string) (optional)
  • kParameterAdNetworkClickID (string) (optional)
  • kParameterCP1 (string) (optional)

kEventCheckoutProgress

const char *const kEventCheckoutProgress = "checkout_progress"

Checkout progress.

Params:

  • kParameterCheckoutStep (unsigned 64-bit integer)
  • kParameterCheckoutOption (string) (optional)

kEventEarnVirtualCurrency

const char *const kEventEarnVirtualCurrency = "earn_virtual_currency"

Earn Virtual Currency event.

This event tracks the awarding of virtual currency in your app. Log this along with kEventSpendVirtualCurrency to better understand your virtual economy. Params:

  • kParameterVirtualCurrencyName (string)
  • kParameterValue (signed 64-bit integer or double)

kEventEcommercePurchase

const char *const kEventEcommercePurchase = "ecommerce_purchase"

E-Commerce Purchase event.

This event signifies that an item was purchased by a user. Note: This is different from the in-app purchase event, which is reported automatically for App Store-based apps. Note: If you supply the kParameterValue parameter, you must also supply the kParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

  • kParameterCurrency (string) (optional)
  • kParameterValue (double) (optional)
  • kParameterTransactionID (string) (optional)
  • kParameterTax (double) (optional)
  • kParameterShipping (double) (optional)
  • kParameterCoupon (string) (optional)
  • kParameterLocation (string) (optional)
  • kParameterStartDate (string) (optional)
  • kParameterEndDate (string) (optional)
  • kParameterNumberOfNights (signed 64-bit integer) (optional) for hotel bookings
  • kParameterNumberOfRooms (signed 64-bit integer) (optional) for hotel bookings
  • kParameterNumberOfPassengers (signed 64-bit integer) (optional) for travel bookings
  • kParameterOrigin (string) (optional)
  • kParameterDestination (string) (optional)
  • kParameterTravelClass (string) (optional) for travel bookings

kEventGenerateLead

const char *const kEventGenerateLead = "generate_lead"

Generate Lead event.

Log this event when a lead has been generated in the app to understand the efficacy of your install and re-engagement campaigns. Note: If you supply the kParameterValue parameter, you must also supply the kParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

  • kParameterCurrency (string) (optional)
  • kParameterValue (double) (optional)

kEventJoinGroup

const char *const kEventJoinGroup = "join_group"

Join Group event.

Log this event when a user joins a group such as a guild, team or family. Use this event to analyze how popular certain groups or social features are in your app. Params:

  • kParameterGroupID (string)

kEventLevelUp

const char *const kEventLevelUp = "level_up"

Level Up event.

This event signifies that a player has leveled up in your gaming app. It can help you gauge the level distribution of your userbase and help you identify certain levels that are difficult to pass. Params:

  • kParameterLevel (signed 64-bit integer)
  • kParameterCharacter (string) (optional)

kEventLogin

const char *const kEventLogin = "login"

Login event.

Apps with a login feature can report this event to signify that a user has logged in.

kEventPostScore

const char *const kEventPostScore = "post_score"

Post Score event.

Log this event when the user posts a score in your gaming app. This event can help you understand how users are actually performing in your game and it can help you correlate high scores with certain audiences or behaviors. Params:

  • kParameterScore (signed 64-bit integer)
  • kParameterLevel (signed 64-bit integer) (optional)
  • kParameterCharacter (string) (optional)

kEventPresentOffer

const char *const kEventPresentOffer = "present_offer"

Present Offer event.

This event signifies that the app has presented a purchase offer to a user. Add this event to a funnel with the kEventAddToCart and kEventEcommercePurchase to gauge your conversion process. Note: If you supply the kParameterValue parameter, you must also supply the kParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

  • kParameterQuantity (signed 64-bit integer)
  • kParameterItemID (string)
  • kParameterItemName (string)
  • kParameterItemCategory (string)
  • kParameterItemLocationID (string) (optional)
  • kParameterPrice (double) (optional)
  • kParameterCurrency (string) (optional)
  • kParameterValue (double) (optional)

kEventPurchaseRefund

const char *const kEventPurchaseRefund = "purchase_refund"

E-Commerce Purchase Refund event.

This event signifies that an item purchase was refunded. Note: If you supply the kParameterValue parameter, you must also supply the kParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

  • kParameterCurrency (string) (optional)
  • kParameterValue (double) (optional)
  • kParameterTransactionID (string) (optional)

kEventRemoveFromCart

const char *const kEventRemoveFromCart = "remove_from_cart"

Remove from cart event.

Params:

  • kParameterQuantity (signed 64-bit integer)
  • kParameterItemID (string)
  • kParameterItemName (string)
  • kParameterItemCategory (string)
  • kParameterItemLocationID (string) (optional)
  • kParameterPrice (double) (optional)
  • kParameterCurrency (string) (optional)
  • kParameterValue (double) (optional)
  • kParameterOrigin (string) (optional)
  • kParameterDestination (string) (optional)
  • kParameterStartDate (string) (optional)
  • kParameterEndDate (string) (optional)

kEventSearch

const char *const kEventSearch = "search"

Search event.

Apps that support search features can use this event to contextualize search operations by supplying the appropriate, corresponding parameters. This event can help you identify the most popular content in your app. Params:

  • kParameterSearchTerm (string)
  • kParameterStartDate (string) (optional)
  • kParameterEndDate (string) (optional)
  • kParameterNumberOfNights (signed 64-bit integer) (optional) for hotel bookings
  • kParameterNumberOfRooms (signed 64-bit integer) (optional) for hotel bookings
  • kParameterNumberOfPassengers (signed 64-bit integer) (optional) for travel bookings
  • kParameterOrigin (string) (optional)
  • kParameterDestination (string) (optional)
  • kParameterTravelClass (string) (optional) for travel bookings

kEventSelectContent

const char *const kEventSelectContent = "select_content"

Select Content event.

This general purpose event signifies that a user has selected some content of a certain type in an app. The content can be any object in your app. This event can help you identify popular content and categories of content in your app. Params:

  • kParameterContentType (string)
  • kParameterItemID (string)

kEventSetCheckoutOption

const char *const kEventSetCheckoutOption = "set_checkout_option"

Set checkout option.

Params:

  • kParameterCheckoutStep (unsigned 64-bit integer)
  • kParameterCheckoutOption (string)

kEventShare

const char *const kEventShare = "share"

Share event.

Apps with social features can log the Share event to identify the most viral content. Params:

  • kParameterContentType (string)
  • kParameterItemID (string)

kEventSignUp

const char *const kEventSignUp = "sign_up"

Sign Up event.

This event indicates that a user has signed up for an account in your app. The parameter signifies the method by which the user signed up. Use this event to understand the different behaviors between logged in and logged out users. Params:

  • kParameterSignUpMethod (string)

kEventSpendVirtualCurrency

const char *const kEventSpendVirtualCurrency = "spend_virtual_currency"

Spend Virtual Currency event.

This event tracks the sale of virtual goods in your app and can help you identify which virtual goods are the most popular objects of purchase. Params:

  • kParameterItemName (string)
  • kParameterVirtualCurrencyName (string)
  • kParameterValue (signed 64-bit integer or double)

kEventTutorialBegin

const char *const kEventTutorialBegin = "tutorial_begin"

Tutorial Begin event.

This event signifies the start of the on-boarding process in your app. Use this in a funnel with kEventTutorialComplete to understand how many users complete this process and move on to the full app experience.

kEventTutorialComplete

const char *const kEventTutorialComplete = "tutorial_complete"

Tutorial End event.

Use this event to signify the user's completion of your app's on-boarding process. Add this to a funnel with kEventTutorialBegin to gauge the completion rate of your on-boarding process.

kEventUnlockAchievement

const char *const kEventUnlockAchievement = "unlock_achievement"

Unlock Achievement event.

Log this event when the user has unlocked an achievement in your game. Since achievements generally represent the breadth of a gaming experience, this event can help you understand how many users are experiencing all that your game has to offer. Params:

  • kParameterAchievementID (string)

kEventViewItem

const char *const kEventViewItem = "view_item"

View Item event.

This event signifies that some content was shown to the user. This content may be a product, a webpage or just a simple image or text. Use the appropriate parameters to contextualize the event. Use this event to discover the most popular items viewed in your app. Note: If you supply the kParameterValue parameter, you must also supply the kParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

  • kParameterItemID (string)
  • kParameterItemName (string)
  • kParameterItemCategory (string)
  • kParameterItemLocationID (string) (optional)
  • kParameterPrice (double) (optional)
  • kParameterQuantity (signed 64-bit integer) (optional)
  • kParameterCurrency (string) (optional)
  • kParameterValue (double) (optional)
  • kParameterStartDate (string) (optional)
  • kParameterEndDate (string) (optional)
  • kParameterFlightNumber (string) (optional) for travel bookings
  • kParameterNumberOfPassengers (signed 64-bit integer) (optional) for travel bookings
  • kParameterNumberOfNights (signed 64-bit integer) (optional) for travel bookings
  • kParameterNumberOfRooms (signed 64-bit integer) (optional) for travel bookings
  • kParameterOrigin (string) (optional)
  • kParameterDestination (string) (optional)
  • kParameterSearchTerm (string) (optional) for travel bookings
  • kParameterTravelClass (string) (optional) for travel bookings

kEventViewItemList

const char *const kEventViewItemList = "view_item_list"

View Item List event.

Log this event when the user has been presented with a list of items of a certain category. Params:

  • kParameterItemCategory (string)

kEventViewSearchResults

const char *const kEventViewSearchResults = "view_search_results"

View Search Results event.

Log this event when the user has been presented with the results of a search. Params:

  • kParameterSearchTerm (string)

Send feedback about...

Need help? Visit our support page.