This article covers the analytics available within AXIS and explains the trackable event types.
Read on to find out more or jump to a specific section of interest.
Compatibility
This article provides analytics details for AXIS Ref Apps version 6.11, 6.10, and 6.9.
Note: From Ref Apps 6.11 onwards, clients are offered the latest version of our modular solution, which includes integration with Google Firebase Analytics (based on Google Analytics), designed to work consistently across all Reference Apps.
Before you can use the data, your developers must first configure the events according to your specific business requirements and integrate them with an appropriate third-party analytics tool.
For the Firebase Analytics solution, only initial configuration is required before you are ready to use it.
What are AXIS Analytics?
AXIS Analytics are a set of built-in analytics events and event data, available through the Analytics API, that allows you to monitor activity in a standardized way across all the Reference Apps.
The AXIS Analytics API is designed to be directly integrated with third-party analytics SDKs. Track critical application events and gather information on user activity so you can adapt, react, and customize your offering.
Analytics gives you a better understanding of your users, including user behavior, preferences, and engagement patterns, as well as the performance of your asset, empowering you to make data-driven decisions.
Data gathered from rows, pages, and page elements that support user behavior tracking can inform the user groups and segmentation tags you create. They also provide an insight into users’ interests, allowing you to target content more successfully.
Ref Apps Analytics version 6.11
From Ref Apps version 6.11 onwards, clients are provided with the latest version of our modular analytics solution, which includes integration with Google Firebase.
Google Firebase provides a robust, scalable analytics solution that includes automatic event tracking, user property tracking, and integration with other Firebase features. It's designed to help you understand how users interact with your app and make informed decisions to improve the user experience.
Configuration
Integration involves setting up a Firebase project, adding your app to the project, and configuring Firebase SDKs for each platform (Android, iOS, Web, etc.). This setup enables the collection of data across various stages of app usage, from installation to in-app activities.
Key features
- Automatic event tracking: Automatically tracks some key events without additional coding.
- Custom events: Offers the ability to track custom events specific to your app's needs.
- User properties: Allows for tracking of specific attributes to better understand user segments.
- Integration with other Firebase services: Enables leveraging other Firebase services like Crashlytics, Cloud Messaging, Dynamic Links, etc., for a more comprehensive solution.
Four key event types can be tracked in AXIS Ref Apps 6.11 onwards:
- Application events track the application lifecycle
- User events track how users interact with the application
- Browse events track how users interact with pages and content
- Item events track how users interact with specific assets.
For detailed steps on configuring Google Firebase Analytics, refer to the comprehensive guide provided in the Firebase documentation.
Expand the accordions below to find out more about each event type.
Application events
Application events provide information on the various states your application goes through. Reviewing these events can help you troubleshoot problems.
The following application event states are captured:
| Event | Description | Context |
|---|---|---|
| App Started | Application initialized | This event is dispatched when the application is first initialized. It should be the first analytics event dispatched from the application. |
| App Ready | Application ready for user interaction | This event is dispatched when the user can start interacting with the application. The event is used to measure Time to Interactive (TTI). |
| App Suspended | Application suspended | This event is dispatched when the application's state changes from foreground to background.
Applies to native apps. |
| App Restored | Application resumed after suspension | This event is dispatched when the application's state changes from background to foreground.
Applies to native apps. |
| App Closed |
Application closed by user |
This event is dispatched when the application is manually shut down by the user.
Applies to native apps. |
| App Offline | Application has gone offline | This event is dispatched when the application goes offline or loses connectivity.
Not applicable to native apps. |
| App Online | Application has come back online | This event is dispatched when the application is back online or regains connectivity.
Not applicable to native apps. |
User events track the interactions your users have with your application, such as registering and signing in and out.
| Event | Description | Context |
|---|---|---|
| User Identified | Identifies a unique anonymous or authenticated user, or tracks a change in user status | This event is dispatched when an anonymous or authenticated user is identified. It's dispatched immediately after the App Started event (see above) and whenever the user's authentication or account status changes. |
| User Profile Selected | User has selected or switched profile | This event is dispatched when a user selects a profile or switches to a different profile. |
| User Signed Out | User has signed out of the application | This event is dispatched when the user signs out of the application. |
| User Actioned | An extension point for custom user or account events | This event is used as an extension point for tracking other user events. |
| User Registered | User has successfully completed the registration flow | This event is dispatched when the user has successfully completed registration.
Applies to Reference web apps. |
Browse events track user interactions within pages and content in the application.
| Event | Description | Context |
|---|---|---|
| Page Viewed | Tracks a page or screen, based on the AXIS sitemap | This event is triggered every time the user navigates to a new page or screen on the sitemap. |
| Searched | Tracks the results of a keyword search | This event tracks a user's search query and the corresponding results — including when zero results are returned. |
| CTA actioned | Tracks when a user actions a CTA | This event tracks when a user actions a CTA ('call to action', e.g., a button). |
*As defined during analytics configuration.
Item events track users' engagement with specific assets in the application.
| Event | Description | Context |
|---|---|---|
| Item Viewed | A user views the detail page/screen for an item | This event is triggered every time the user views a specific item on a page or screen. |
| Item Clicked | Tracks when a user clicks or selects an item's thumbnail | This event is dispatched when a user clicks on or selects an item. |
| Item Followed | Tracks when a user follows or unfollows an item | This event is triggered when a user follows or unfollows an item. |
| Item Watched | Tracks when a user clicks on the Watch CTA associated with an item | This event is dispatched when a user selects a Watch or Resume action for an item. |
| Item Bookmarked | Tracks when a user bookmarks an item | This event is dispatched when a user adds or removes a bookmark. |
| Item Rated | Tracks when a user rates an item | This event is dispatched when a user adds a rating to an item. |
*As defined during analytics configuration.
Ref Apps Analytics version 6.10 and 6.9
The Ref Apps 6.10 on Android TV, and 6.9 on Responsive web and webTV, Android mobile and tablet, iOS, iPadOS, and tvOS, and Roku releases deliver a simplified, configurable, maintainable, and extendable modular OOTB AXIS Analytics solution.
The improved Analytics module is designed in such a way that:
- It provides an OOTB solution with a 3rd Party (Google Firebase Analytics) and a set of events
- When new events are added, they are included in the OOTB set of events
- When new 3rd parties are implemented, they are available OOTB
The following four key event types are trackable in AXIS:
- Application events track the application lifecycle
- User events track how users interact with the application
- Browse events track how users interact with pages and content
- Item events track how users interact with specific assets
Expand the accordions below to find out more about each event type.
Application events
Application events provide information on the various states your application goes through. Reviewing these events can help you troubleshoot problems.
The following application event states are captured:
| Event | Description | Context |
|---|---|---|
| App Started | Application initialized | This event is dispatched when the application is first initialized. It should be the first analytics event dispatched from the application. |
| App Ready | Application ready for user interaction | This event is dispatched when the user can start interacting with the application. The event is used to measure Time to Interactive (TTI). |
| App Suspended | Application suspended | This event is dispatched when the application's state changes from foreground to background.
Applies to native apps. |
| App Restored | Application resumed after suspension | This event is dispatched when the application's state changes from background to foreground.
Applies to native apps. |
| App Closed |
Application closed by user |
This event is dispatched when the application is manually shut down by the user.
Applies to native apps. |
| App Offline | Application has gone offline | This event is dispatched when the application goes offline or loses connectivity.
Not applicable to native apps. |
| App Online | Application has come back online | This event is dispatched when the application is back online or regains connectivity.
Not applicable to native apps. |
User events track the interactions your users have with your application, such as registering and signing in and out.
| Event | Description | Context |
|---|---|---|
| User Identified | Identifies a unique anonymous or authenticated user, or tracks a change in user status | This event is dispatched when an anonymous or authenticated user is identified. It's dispatched immediately after the App Started event (see above) and whenever the user's authentication or account status changes. |
| User Profile Selected | User has selected or switched profile | This event is dispatched when a user selects a profile or switches to a different profile. |
| User Signed Out | User has signed out of the application | This event is dispatched when the user signs out of the application. |
| User Actioned | An extension point for custom user or account events | This event is used as an extension point for tracking other user events. |
| User Registering | User has started or progressed the registration flow | This event is dispatched during each step of the registration process.
Applies to Reference web apps. |
| User Registered | User has successfully completed the registration flow | This event is dispatched when the user has successfully completed registration.
Applies to Reference web apps. |
Browse events track user interactions within pages and content in the application.
| Event | Description | Context |
|---|---|---|
| Page Viewed | Tracks a page or screen, based on the AXIS sitemap | This event is triggered every time the user navigates to a new page or screen on the sitemap. |
| Searched | Tracks the results of a keyword search | This event tracks a user's search query and the corresponding results - including when zero results are returned. |
| CTA actioned | Tracks when a user actions a CTA | This event tracks when a user actions a CTA ('call to action', e.g., a button). |
*As defined during analytics configuration.
Item events track users’ engagement with specific assets in the application.
| Event | Description | Context |
|---|---|---|
| Item Viewed | A user views the detail page/screen for an item | This event is triggered every time the user views a specific item on a page or screen |
| Item Clicked | Tracks when a user clicks or selects an item's thumbnail | This event is dispatched when a user clicks on or selects an item. |
| Item Watched | Tracks when a user clicks on the Watch CTA associated with an item | This event is dispatched when a user selects a Watch or Resume action for an item. |
| Item Bookmarked | Tracks when a user bookmarks an item | This event is dispatched when a user adds or removes a bookmark. |
| Item Rated | Tracks when a user rates an item | This event is dispatched when a user adds a rating to an item. |
*As defined during analytics configuration.