3rd party integrations
...
Purple Tracking
Tracking Events

Action events

170min

Getting started

In the graphic below you can see the part that is covered in this chapter:

Document image


A purple application technically consists of a native part and an experience part that runs within a web view.

The action events in this documentation are listed under the Native app or Experience subchapters based on the origin they occur.

Native app

APP_BACKGROUND

The event name app_background is a reserved event on Firebase Analytics. You need to use a different event name if you use a custom tracking config.

Trigger
Placeholders
Examples

Android / iOS: When the app is left via home button or home indicator.



APP_BOOKMARK_ADDED

Trigger
Placeholders
Examples

Android / iOS: Bookmark was added via native action bar toggle or action URL.



APP_BOOKMARK_DELETED

Trigger
Placeholders
Examples

Android / iOS: Bookmark was removed via native action bar toggle.



APP_CONTENT_SHARED

Trigger
Placeholders
Examples

Android / iOS: When the user successfully performed the content share via * action bar button or one of the following action URLs * purple://app/share_app_or_issue * purple://app/share_app_or_issue_or_page when an issue is opened.



APP_FOREGROUND

Trigger
Placeholders
Examples

Android / iOS: When the app comes back to the foreground after being in the background, not during the initial app start.



APP_SHARED

Trigger
Placeholders
Examples

Android / iOS: When the user performed the app share.



APP_START

Trigger
Placeholders
Examples

Android / iOS: When the app starts, not when it is brought back from the background.



APP_STOP

Trigger
Placeholders
Examples

Android / iOS: When the app stops (e.g. terminated by the system or user). Not when leaving the app using the home button/home gesture.



CONTENT_OPEN_FAILED

Trigger
Placeholders
Examples

Android / iOS: Triggered content could not be opened, e.g. * for content.open failures or one of the following action URLs: * open issue by ID * open issue by alias * open issue by external ID



ISSUE_OPENED

Trigger
Placeholders
Examples

Triggered when an issue is opened inside the pager.



ISSUE_PAGE_OPENED

Trigger
Placeholders
Examples

Triggered when a page of an issue is opened inside the pager.



ISSUE_PREVIEW_OPENED

Trigger
Placeholders
Examples

Triggered when a preview of an issue is opened inside the pager.



KIOSK_MENU_ENTITLEMENT_LOGIN_FAILED

Trigger
Placeholders
Examples

Android: When the entitlement login failed via action URL: purple://kiosk/entitlement/login/perform iOS:

When the entitlement login failed (via any method).



KIOSK_MENU_ENTITLEMENT_LOGIN_SUCCEEDED

Trigger
Placeholders
Examples

Android: When the entitlement login succeded via action URL: purple://kiosk/entitlement/login/perform iOS: When the entitlement login was successful (via any method).



KIOSK_PURCHASE_RESTORATION_FAILED

Trigger
Placeholders
Examples

Android: This event does not exist. iOS: When restore purchases failed via: * action URL * JS API



KIOSK_PURCHASES_RESTORED

Trigger
Placeholders
Examples

Android: This event does not exist. iOS: When restore purchases succeeded via * action URL * JS API



PRESENTER_ARTICLE_VISIBILITY

Available for PDF issues only and needs content specific configuration.

Trigger
Placeholders
Examples

Android: Every time a page becomes visible. iOS: Every time a page is shown (e.g. open, swipe between pages).



PRESENTER_CONTENT_PREVIEW_TOC_OPENED

Trigger
Placeholders
Examples

Android / iOS: When the table of contents popup is opened for a preview issue.



PRESENTER_CONTENT_TOC_OPENED

Trigger
Placeholders
Examples

Android / iOS: When the table of contents popup is opened for an issue.



PRESENTER_CONTENT_URL_OPENED

Trigger
Placeholders
Examples

Android: When an URL or action URL is opened via storytelling open action. iOS: When an URL or action URL is opened via storytelling action (not limited to open) or action URL via webview navigation.



Experience

ISSUE_DELETED

Trigger
Placeholders
Examples

When content_type was deleted

  • by user interaction or
  • in case of content_type "issue" the native app mechanism "Automatic deletion of issues"


ISSUE_DOWNLOAD_CANCELLED

Trigger
Placeholders
Examples

When a download of content_type was cancelled.



ISSUE_DOWNLOAD_FAILED

Trigger
Placeholders
Examples

When a download of content_type failed.



ISSUE_DOWNLOAD_STARTED

Trigger
Placeholders
Examples

When a download of content_type started.



ISSUE_DOWNLOADED

Trigger
Placeholders
Examples

When a download of content_type was successful.



STOREFRONT_<content_type>_BOOKMARK_ADD_CLICKED

Trigger
Placeholders
Examples

When the bookmark button of a content_type is clicked. This event is only triggered if no bookmark exists for this content_type.



STOREFRONT_<content_type>_BOOKMARK_ADD_FAILED

Trigger
Placeholders
Examples

When adding a bookmark for a content_type failed.



STOREFRONT_<content_type>_BOOKMARK_ADDED

Trigger
Placeholders
Examples

When a bookmark was added successfully for a content_type.



STOREFRONT_<content_type>_BOOKMARK_DELETE_CLICKED

Trigger
Placeholders
Examples

When the bookmark delete button of a content_type is clicked.



STOREFRONT_<content_type>_BOOKMARK_DELETE_FAILED

Trigger
Placeholders
Examples

When deleting a bookmark for a content_type failed.



STOREFRONT_<content_type>_BOOKMARK_DELETED

Trigger
Placeholders
Examples

When a bookmark of content_type was successfully deleted.



STOREFRONT_<content_type>_BOOKMARK_OPEN_CLICKED

Trigger
Placeholders
Examples

When the bookmark open button of a content_type is clicked.



STOREFRONT_<content_type>_COUPON_CLICKED

Trigger
Placeholders
Examples

When the coupon button of a content_type is clicked.



STOREFRONT_<content_type>_COVER_CLICKED

Trigger
Placeholders
Examples

When the cover (the image) of a content_type is clicked.



STOREFRONT_<content_type>_LOGIN_CLICKED

Trigger
Placeholders
Examples

When the login button of a content_type is clicked.



STOREFRONT_<content_type>_PREVIEW_CLICKED

Trigger
Placeholders
Examples

When the preview button of a content_type is clicked.



STOREFRONT_<content_type>_READ_CLICKED

Trigger
Placeholders
Examples

When the read button of a content_type is clicked.



STOREFRONT_<content_type>_SEARCH_RESULT_COVER_CLICKED

Trigger
Placeholders
Examples

When the search result cover (the image) of a content_type is clicked.



STOREFRONT_<content_type>_SEARCH_RESULT_PAGE_HIT_CLICKED

Trigger
Placeholders
Examples

When the search result page hit of a content_type is clicked. Every page in search result contains the search term.



STOREFRONT_<content_type>_SHARE_CLICKED

Trigger
Placeholders
Examples

When the share button of a content_type is clicked.



STOREFRONT_<content_type>_SHARE_FAILED

Trigger
Placeholders
Examples

When content_type sharing failed.



STOREFRONT_<content_type>_SHARED

Trigger
Placeholders
Examples

When a content_type was shared.



STOREFRONT_<content_type>_SUBSCRIBE_CLICKED

Trigger
Placeholders
Examples

When the subscribe button of a content_type is clicked.



STOREFRONT_AD_CLICKED

Trigger
Placeholders
Examples

When an ad is clicked.



STOREFRONT_AD_STICKY_CLICKED

Trigger
Placeholders
Examples

When a sticky ad is clicked.



STOREFRONT_APP_BAR_BACK_CLICKED

Trigger
Placeholders
Examples

When the back button in the app bar is clicked.



STOREFRONT_APP_BAR_LOGO_CLICKED

Trigger
Placeholders
Examples

When the logo in the app bar is clicked.



STOREFRONT_APP_BAR_MENU_CLICKED

Trigger
Placeholders
Examples

When the menu button in the app bar is clicked.



STOREFRONT_BOOKMARK_DELETE_ALL_CLICKED

Trigger
Placeholders
Examples

When a delete all bookmarks button action is triggered.



STOREFRONT_BOOKMARK_DELETED_ALL

Trigger
Placeholders
Examples

When a delete all bookmarks action is finished.



STOREFRONT_BOOKMARK_DELETE_ALL_FAILED

Trigger
Placeholders
Examples

When a delete all bookmarks action failed.



STOREFRONT_BOOKMARK_DELETE_ALL_OF_ISSUE_CLICKED

Trigger
Placeholders
Examples

When a delete all bookmarks action is triggered for a specific issue.



STOREFRONT_BOOKMARK_DELETED_ALL_OF_ISSUE

Trigger
Placeholders
Examples

When a delete all bookmarks action is finished for a specific issue.



STOREFRONT_BOOKMARK_DELETE_ALL_OF_ISSUE_FAILED

Trigger
Placeholders
Examples

When a delete all bookmark action failed for a specific issue.



STOREFRONT_EXTERNAL_LOGIN_CANCELLED

Trigger
Placeholders
Examples

When an external login process failed.



STOREFRONT_EXTERNAL_LOGIN_CLICKED

Trigger
Placeholders
Examples

When an external login process is started.



STOREFRONT_EXTERNAL_LOGIN_SUCCEEDED

Trigger
Placeholders
Examples

When an external login process finished successfully.



STOREFRONT_HTML_CLICKED

Trigger
Placeholders
Examples

When a HTML component is tapped for which a tap action is configured.



STOREFRONT_HTML_LINK_OPEN_APP_BROWSER

Trigger
Placeholders
Examples

When an anchor/link is tapped which occurs in the content of an HTML component. Only tracked if the link target is opened in the in-app browser.



STOREFRONT_HTML_LINK_OPEN_EXTERNAL

Trigger
Placeholders