Actions

APP_BOOKMARK_ADDED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

A bookmark was added by the user.

Template placeholder Example values
CONTENT_ID <PUBLICATION_ID>/<ISSUE_ID>
CONTENT_NAME displayName (Name) of the Issue
BOOKMARK_TITLE Issues: same as CONTENT_NAME, Articles: displayName (Name) of Publication
BOOKMARK_SECTION Issues: Section of the ToC, Articles: displayName (Name) of Issue

APP_BOOKMARK_DELETED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

A bookmark was deleted by the user.

Template placeholder Example values
CONTENT_ID <PUBLICATION_ID>/<ISSUE_ID>
CONTENT_NAME displayName (Name) of the Issue
BOOKMARK_TITLE Issues: same as CONTENT_NAME, Articles: displayName (Name) of Publication
BOOKMARK_SECTION Issues: Section of the ToC, Articles: displayName (Name) of Issue

APP_START

New in version (Android): 2.1.0
New in version (iOS): 2.1.0
New in version (Web Kiosk): 3.2.2

The app has been started.

This event has no template placeholders.

APP_STOP

New in version (Android): 2.1.0
New in version (iOS): 2.1.0
New in version (Web Kiosk): 3.2.2

The app has been stopped.

This event has no template placeholders.

APP_FOREGROUND

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

The app has been resumed, e.g. through the recent tasks.

This event has no template placeholders.

APP_BACKGROUND

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

The app has been minimized, e.g. using the home button.

This event has no template placeholders.

APP_SHARED

New in version (Android): 2.1.0
New in version (iOS): 2.5.0

The app has been shared.

This event has no template placeholders.

APP_CONTENT_SHARED

New in version (Android): 2.1.0
New in version (iOS): 2.5.0

The user has shared the currently visible content.

Template placeholder Example values
CONTENT_ID The content id of the shared content.
CONTENT_NAME The name of the shared content, e.g. the issue name.

KIOSK_PROMOTION_OPEN_ACTION

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

An url has been opened from the promotion area in the kiosk.

Template placeholder Example values
ACTION_URL The url which has been opened.

KIOSK_PUBLICATION_OPENED

New in version (Android): 2.1.0
New in version (iOS): 2.5.0
New in version (Web Kiosk): 3.2.2

A publication has been selected in the publication filter menu in the kiosk.

Template placeholder Example values
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication. The name of the property is used as the placeholder key.

KIOSK_CHANNEL_OPENED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

A channel has been selected in the channel pager.

Template placeholder Example values
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

KIOSK_COUPON_ACTIVATED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

A coupon code has been activated.

Template placeholder Example values
COUPON_CODE The coupon code which has been activated.

Warning

This event has been renamed to KIOSK_SUBSCRIPTION_CODE_ACTIVATED in version 2.3. All configurations have to be manually adjusted to use the new event name.

KIOSK_COUPON_DEACTIVATED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

A coupon code has been deactivated.

Template placeholder Example values
COUPON_CODE The coupon code which has been deactivated.

Warning

This event has been renamed to KIOSK_SUBSCRIPTION_CODE_DEACTIVATED in version 2.3. All configurations have to be manually adjusted to use the new event name.

KIOSK_SUBSCRIPTION_CODE_ACTIVATED

New in version (Android): 2.3.0
New in version (iOS): 2.3.0
New in version (Web Kiosk): 3.2.2

A subscription code has been activated.

Template placeholder Example values
SUBSCRIPTION_CODE The coupon code which has been activated.

KIOSK_SUBSCRIPTION_CODE_DEACTIVATED

New in version (Android): 2.3.0
New in version (iOS): 2.3.0
New in version (Web Kiosk): 3.2.2

A subscription code has been deactivated.

Template placeholder Example values
SUBSCRIPTION_CODE The coupon code which has been deactivated.

KIOSK_ISSUE_DELETED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

An issue has been deleted.

Template placeholder Example values
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

KIOSK_ISSUE_DOWNLOAD_STARTED

New in version (Android): 2.5.0
New in version (iOS): 2.5.0

An issue download has been started.

Template placeholder Example values
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

KIOSK_ISSUE_DOWNLOAD_CANCELLED

New in version (Android): 2.5.0
New in version (iOS): 2.5.0

An issue download has been cancelled.

Template placeholder Example values
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

KIOSK_ISSUE_DOWNLOAD_FAILED

New in version (Android): 2.5.0
New in version (iOS): 2.5.0

An issue download has failed.

Template placeholder Example values
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

KIOSK_ISSUE_DOWNLOADED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

An issue has been downloaded.

Template placeholder Example values
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

KIOSK_ISSUE_PREVIEW_DOWNLOADED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

A preview issue has been downloaded.

Template placeholder Example values
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

KIOSK_ISSUE_OPENED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0
New in version (Web Kiosk): 3.2.2

An issue has been opened.

Template placeholder Example values
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

KIOSK_ISSUE_OPEN_FAILED

New in version (Android): 2.5.0
New in version (iOS): ?.?.?
New in version (Web Kiosk): 3.2.2

An issue could not be opened. This can happen if the user tried to open an issue though a deep-link / action-url which is not available in the kiosk.

Template placeholder Example values
ISSUE_ID The id of the issue.

KIOSK_ISSUE_PREVIEW_OPENED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

A preview issue has been opened.

Template placeholder Example values
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

KIOSK_ISSUE_PURCHASE_CANCELLED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

An issue purchase has been cancelled/aborted.

Template placeholder Example values
PRODUCT_ID The product id of the issue.
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

KIOSK_ISSUE_PURCHASED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

An issue has been purchase.

Template placeholder Example values
PRODUCT_ID The product id of the issue.
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

KIOSK_ISSUE_TOC_OPENED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

The table of contents of an issue have been opened in the issue preview screen.

Template placeholder Example values
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

KIOSK_ISSUE_PREVIEW_TOC_OPENED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

The table of contents of a preview issue have been opened in the issue preview screen.

Template placeholder Example values
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

KIOSK_PURCHASES_RESTORED

New in version (iOS): 2.1.0

The in-app purchases have been manually restored.

This event has no template placeholders.

Warning

This events is not available on Android as purchases are restored automatically after each kiosk sync.

KIOSK_PURCHASE_RESTORATION_FAILED

New in version (iOS): 2.1.0

The in-app purchases could not be restored.

This event has no template placeholders.

Warning

This events is not available on Android as purchases are restored automatically after each kiosk sync.

KIOSK_SUBSCRIPTION_PURCHASE_CANCELLED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

A subscription purchase has been cancelled/aborted.

Template placeholder Example values
SUBSCRIPTION_ID The id of the subscription.
SUBSCRIPTION_NAME The name of the subscription.
PRODUCT_ID The product id of the subscription.

Additionally you can use all custom properties which are configured for the subscription. The name of the property is used as the placeholder key.

KIOSK_SUBSCRIPTION_PURCHASED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

A subscription has been purchased.

Template placeholder Example values
SUBSCRIPTION_ID The id of the subscription.
SUBSCRIPTION_NAME The name of the subscription.
PRODUCT_ID The product id of the subscription.

Additionally you can use all custom properties which are configured for the subscription. The name of the property is used as the placeholder key.

KIOSK_MENU_ENTITLEMENT_LOGIN_SUCCEEDED

New in version (Android): 2.5.0
New in version (iOS): 2.5.0
New in version (Web Kiosk): 3.2.2

This event will be tracked if the entitlement login was successful.

Template placeholder Example values
USERNAME The username used to login.

KIOSK_MENU_ENTITLEMENT_LOGIN_FAILED

New in version (Android): 2.5.0
New in version (iOS): 2.5.0
New in version (Web Kiosk): 3.2.2

This event will be tracked if the entitlement login has failed.

Template placeholder Example values
USERNAME The username used to login.

KIOSK_ENTITLEMENT_LINK1_OPENED

New in version (Android): 2.5.0
New in version (iOS): 2.5.0

This event will be tracked if the first entitlement link was opened.

Template placeholder Example values
LABEL The displayed text of the link.
URL The actual url of the link.

KIOSK_ENTITLEMENT_LINK2_OPENED

New in version (Android): 2.5.0
New in version (iOS): 2.5.0

This event will be tracked if the second entitlement link was opened.

Template placeholder Example values
LABEL The displayed text of the link.
URL The actual url of the link.

KIOSK_ENTITLEMENT_LINK3_OPENED

New in version (Android): 2.5.0
New in version (iOS): 2.5.0

This event will be tracked if the third entitlement link was opened.

Template placeholder Example values
LABEL The displayed text of the link.
URL The actual url of the link.

PRESENTER_CONTENT_TOC_OPENED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0
New in version (Web Player): 3.1.0

The user has opened the table of contents of the currently visible content.

Template placeholder Example values
CONTENT_ID The content id of the current content.
CONTENT_NAME The name of the current content, e.g. the issue name.

PRESENTER_CONTENT_PREVIEW_TOC_OPENED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0
New in version (Web Player): 3.1.0

The user has opened the table of contents of the currently visible preview content.

Template placeholder Example values
CONTENT_ID The content id of the current content.
CONTENT_NAME The name of the current content, e.g. the issue name.

PRESENTER_CHANNEL_CONTENT_OPENED

New in version (Android): 2.1.0
New in version (iOS): 2.5.0

The user has opened an article. This event will be triggered after 3 seconds of viewing the content.

Template placeholder Example values
CONTENT_ID The content id of the current content.
CONTENT_NAME The name of the current content, e.g. the issue name.

PRESENTER_ISSUE_CONTENT_OPENED

New in version (Android): 2.1.0
New in version (iOS): 2.5.0
New in version (Web Player): 3.1.0

The user has opened an issue.

Template placeholder Example values
CONTENT_ID The content id of the current content.
CONTENT_NAME The name of the current content, e.g. the issue name.

Additionally you can use all custom properties which are configured for the issue. The name of the property is used as the placeholder key.

PRESENTER_CONTENT_PAGE_OPENED

New in version (Android): 2.1.0
New in version (iOS): 2.5.0
New in version (Web Player): 3.1.0

The user has opened a page in the currently visible content.

Template placeholder Example values
CONTENT_ID The content id of the current content.
CONTENT_NAME The name of the current content, e.g. the issue name.
PAGE_ID The id of the page.
PAGE_ALIAS The alias of the page.
PAGE_LABEL The label of the page.
PAGE_INDEX The index of the page.
PAGE_NUMBER The number of the page.
PAGE_TITLE The title of the page.
PAGE_SECTION The section of the page.

PRESENTER_CONTENT_OPEN_FAILED

New in version (Android): 2.5.0
New in version (iOS): 2.5.0
New in version (Web Player): 3.1.0

This event will be tracked if an issue can not be opened, e.g. when its contents are corrupt / invalid.

Template placeholder Example values
CONTENT_ID The content id of the current content.
CONTENT_NAME The name of the current content, e.g. the issue name.

PRESENTER_CONTENT_URL_OPENED

New in version (Android): 2.5.0
New in version (iOS): 2.5.0
New in version (Web Player): 3.1.0

This event will be tracked if a link has been opened from within an issue.

Template placeholder Example values
URL The opened url.
CONTENT_ID The content id of the current content.
CONTENT_NAME The name of the current content, e.g. the issue name.
PAGE_ID The id of the page.
PAGE_ALIAS The alias of the page.
PAGE_LABEL The label of the page.
PAGE_INDEX The index of the page.
PAGE_NUMBER The number of the page.
PAGE_TITLE The title of the page.
PAGE_SECTION The section of the page.

Views

APP_BOOKMARKS

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

The bookmarks screen is currently visible.

This event has no template placeholders.

APP_SHARING

New in version (iOS): 2.1.0

The bookmarks screen is currently visible.

This event has no template placeholders.

Warning

This event is not available on Android.

APP_MENU

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

The app menu is currently visible.

This event has no template placeholders.

KIOSK

New in version (Android): 2.1.0
New in version (iOS): 2.1.0
New in version (Web Kiosk): 3.2.2

The kiosk is currently visible.

This event has no template placeholders.

KIOSK_CHANNEL_FEED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

A channel in the channel feed is currently visible.

Template placeholder Example values
PUBLICATION_ID The id of the channel.
PUBLICATION_NAME The name of the channel.

KIOSK_MY_ISSUES

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

The my issues filter in the kiosk filter is active.

This event has no template placeholders.

KIOSK_PUBLICATION_ALL

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

The all issues filter in the kiosk filter is active.

This event has no template placeholders.

KIOSK_PUBLICATION

New in version (Android): 2.1.0
New in version (iOS): 2.1.0
New in version (Web Kiosk): 3.2.2

A specific publication in the kiosk filter is active.

Template placeholder Example values
PUBLICATION_ID The id of the channel.
PUBLICATION_NAME The name of the channel.

KIOSK_MANAGE_SUBSCRIPTIONS

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

The subscription management screen is visible.

This event has no template placeholders.

KIOSK_ISSUE_PURCHASE

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

The purchase screen of an issue is visible.

Template placeholder Example values
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.

KIOSK_ISSUE_PREVIEW

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

The preview screen of an issue is visible.

Template placeholder Example values
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.

PRESENTER_PAGE

New in version (Android): 2.5.0
New in version (iOS): 2.5.0
New in version (Web Player): 3.1.0

This event tracks the currently visible page in the content. Only real pages can be tracked using this event. Large pages which are scrollable and have the paging enabled are still only tracked as one page.

Template placeholder Example values
CONTENT_ID The content id of the current content.
CONTENT_NAME The name of the current content, e.g. the issue name.
PAGE_ID The id of the page.
PAGE_ALIAS The alias of the page.
PAGE_LABEL The label of the page.
PAGE_INDEX The index of the page.
PAGE_NUMBER The number of the page.
PAGE_TITLE The title of the page.
PAGE_SECTION The section of the page.

PRESENTER_CONTENT

New in version (Android): 2.2.0
New in version (iOS): 2.1.0
New in version (Web Player): 3.1.0

An issue is visible.

Template placeholder Example values
CONTENT_ID The content id of the current content.
CONTENT_NAME The name of the current content, e.g. the issue name.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

PRESENTER_CONTENT_TOC

New in version (Android): 2.2.0
New in version (iOS): 2.1.0
New in version (Web Player): 3.1.0

The table of contents of an issue is visible.

Template placeholder Example values
CONTENT_ID The content id of the current content.
CONTENT_NAME The name of the current content, e.g. the issue name.

Purchases

KIOSK_ISSUE_PURCHASED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

An issue has been purchase.

Template placeholder Example values
PRODUCT_ID The product id of the issue.
PRICE The price of the purchase.
CURRENCY_CODE The currency code of the price.
ISSUE_ID The id of the issue.
ISSUE_NAME The name of the issue.
PUBLICATION_ID The id of the publication.
PUBLICATION_NAME The name of the publication.

Additionally you can use all custom properties which are configured for the publication and issue. The name of the property is used as the placeholder key.

KIOSK_SUBSCRIPTION_PURCHASED

New in version (Android): 2.1.0
New in version (iOS): 2.1.0

A subscription has been purchased.

Template placeholder Example values
PRODUCT_ID The product id of the issue.
PRICE The price of the purchase.
CURRENCY_CODE The currency code of the price.
SUBSCRIPTION_ID The id of the subscription.
SUBSCRIPTION_NAME The name of the subscription.

Additionally you can use all custom properties which are configured for the subscription. The name of the property is used as the placeholder key.


Attributes

HAS_ACTIVE_SUBSCRIPTION

New in version (Android): 2.0.0
New in version (iOS): 2.0.0

This attribute has a value of true if the user has an active subscription, otherwise it has the value false.

This event has no template placeholders.

HAS_ACTIVE_COUPON_CODE

New in version (Android): 2.0.0
New in version (iOS): 2.0.0

This attribute has a value of true if the user has an active coupon code, otherwise it has the value false.

This event has no template placeholders.


Warning

This attribute has been renamed to HAS_ACTIVE_SUBSCRIPTION_CODE in version 2.3. All configurations have to be manually adjusted to use the new event name.

HAS_ACTIVE_SUBSCRIPTION_CODE

New in version (Android): 2.3.0
New in version (iOS): 2.3.0

This attribute has a value of true if the user has an active subscription code, otherwise it has the value false.

This event has no template placeholders.

HAS_ACTIVE_TRIAL

New in version (Android): 2.0.0
New in version (iOS): 2.0.0

This attribute has a value of true if the user has an active trial, otherwise it has the value false.

This event has no template placeholders.

HAS_PURCHASED_ISSUE

New in version (Android): 2.0.0
New in version (iOS): 2.0.0

This attribute has a value of true if the user has purchased at least one issue, otherwise it has the value false.

This event has no template placeholders.

HAS_BOOKMARKS

New in version (Android): 2.0.0
New in version (iOS): 2.0.0

This attribute has a value of true if the user has at least one bookmark, otherwise it has the value false.

This event has no template placeholders.

HAS_ENTITLEMENT_LOGIN

New in version (Android): 2.5.0
New in version (iOS): 2.5.0

Is true if the user has logged in via entitlement. While the user is logged in the attribute value remains true. If the user logs out the attribute value is reset to false.

This event has no template placeholders.