Login

Learning & Support

Documentation

Analytics Events Overview (beta)

Twixl Support Team Updated: - Created :

    The Twixl platform gathers anonymized information about how users/readers interact with your app and the Twixl platform. In Twixl Publisher 16, we introduced vastly improved event tracking. Currently that data is accessible only through the Twixl Admin API, and allows you to import and use it in your own analytics presentations, tables, tools... Below is an overview of all events that are collected. The events will be collected on iOS, Android and the browser client (unless specified differently). Using this feature requires an app built with Twixl Publisher 16.1 or higher.

    IMPORTANT NOTE:

    This is currently a beta feature. If you want to get access to this feature, please open a support ticket. You'll also need to have the Integration API as part of your subscription.

    1. Events in the apps

    1.1. App Install event

    app-install

    This event is logged every time a user launches the app for the very first time on his/her device.

    iOS and Android only.

    1.2. Entitlement login & logout events

    entitlement-login & entitlement-logout

    This event is logged every time a user performs a login or logout via entitlements.

    1.3. Notification opened event

    notification-open

    This event is logged every time a user opens a push notification on his device.

    iOS and Android only.

    1.4. Purchase events

    purchase-item

    This event is logged every time a user purchases a specific content item (PDF) or collection.

    purchase-restore

    This event is logged every time a user performs a restore of the previous purchases.

    purchase-subscription

    This event is logged every time a user purchases a subscription.

    iOS and Android only.

    1.5. Search event

    search

    This event is logged every time a user performs a search query.

    1.6. Session events

    session-start

    This event is logged every time a user launches the app or bring the app to the foreground.

    When the user logs in via entitlements, this is also considered as a new session.

    session-end

    This event is logged every time a user stops the app or when the app goes to the background.

    When the user logs out from entitlements, this also should be considered as a session end.

    iOS and Android only.

    1.7. Social sharing

    social-share

    This event is logged every time a user successfully shares a content item on social media.

    iOS and Android only.

    1.8. View events

    1.8.1. General view events

    view-collection

    This event is logged every time a user goes to a specific collection, regardless of the view mode (browse or detail). If the user first goes to the browse page and then navigates to the detail page, the event is logged twice.

    If the user returns from e.g. a detail view of a collection back to the browse page, these count as separate events.

    view-content-item

    This event is logged every time a user visits a specific content item page. For each page, we log a separate event.

    For PDF content items, every page that is displayed will be logged as well.

    This event is only triggered after the content item has been downloaded and one of the pages is visible on the screen.

    view-pagelink

    This event is logged every time a user taps on a pagelink in a content item. For each page, a separate event will be logged.

    view-paywall

    This event is logged every time a user ends up on the paywall.

    iOS and Android only.

    view-settings

    This event is logged every time a user opens the settings window.

    iOS and Android only.

    view-weblink

    This event is logged every time a user taps a web link in a content item.

    1.8.2. InDesign-specific view events

    view-button

    This event is logged every time a user taps a button in a Twixl InDesign article. For each page, a separate event will be logged.

    view-image-sequence

    This event is logged every time a user swipes or taps on an image sequence in a Twixl article. This event will be counted only once for each page view.

    As long as the user stays on the same page and swipes multiple times on the image sequence, it counts as a single event.

    view-movie

    This event is logged every time a user starts the playback of a movie in a Twixl article (that does not autoplay).

    If the user plays the movie multiple times during the same "page session", only one event will be logged.

    view-scrollable-content

    This event is logged every time a user swipes in a scrollable content item in a Twixl article.

    This event will be counted only once for each page view. As long as the user stays on the same page and swipes multiple times on the scrollable, it will count as a single event.

    view-slideshow-slide

    This event is logged every time a user swipes to another slide in a slide show. If the slideshow is set to autoplay, the event will not be logged.

    view-sound

    This event is logged every time a user taps a sound element in a Twixl article (that does not autoplay).

    If the user plays the sound multiple times during the same "page session", only one event will be logged.

    view-web-overlay-button

    This event is logged every time a user taps on a web overlay button in a Twixl article.

    2. Events on the Twixl platform

    app-create

    This event is logged when a user creates a new app on the Twixl platform.

    app-delete

    This event is logged when a user deletes an app from the Twixl platform.

    collection-create

    This event is sent when a user creates a collection on the Twixl platform.

    collection-delete

    This event is sent when a user deletes a collection on the Twixl platform.

    content-item-create

    This event is sent when a user creates a content item on the Twixl platform.

    content-item-delete

    This event is sent when a user deletes a content item on the Twixl platform.

    download

    This event is logged every time a user performs a download of a content item.

    notification-send

    This event is triggered after a notification for a specific app has been sent.

    Was this article helpful?

    0 out of 0 found this helpful