Prenly Analytics Events - Prenly
Table of Contents
- article_narrative_start
- article_narrative_stop
- article_open
- banner_click
- custom_tab_audio_start
- custom_tab_audio_stop
- external_url_clicked (deprecated)
- favorite_title_add
- favorite_title_remove
- issue_open (deprecated)
- podcast_episode_start
- podcast_episode_stop
- prenly_app_open
- prenly_push_notification_open
- publication_open
- replica_box_link_click
- replica_box_link_view
- replica_page_open
- title_open
- titles_overview_open
article_narrative_start
Trigger mechanism
This event is triggered when an article audio file starts playing in a Prenly reader application. The event is triggered when user hits the play or resume button in the article mode or in the start page's article component and when an article is automatically started within the audio queue.
This event is planned to be introduced in all platforms from Q4- 2024.
Event attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| playback_position | Player | int | Current playback position in seconds |
| audio_duration | Player | int | The total duration of the audio file, in seconds |
| audio_url | Player | string | The url of the audio file |
| article_uid | Article | string | The unique identifier of the article |
| article_name | Article | string | User-readable article name |
| article_slug | Article | string | Computer-readable article name |
| title_slug | Title | string | Computer-friendly title name |
| title_uid | Title | string | The unique identifier of the title |
| publication_date | Publication | string | Publication date on form YYYY-MM-DD |
| publication_slug | Publication | string | Computer-friendly publication label |
| publication_uid | Publication | string | The unique identifier of the publication |
The attributes with the suffix ? are not always available.
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| playback_position | 0 |
| audio_duration | 76 |
| audio_url | “https://epaper.domain.com/audio/articlexxyyzz.mp3 |
| article_uid | "33285619" |
| article_external_id? | "e2b884d5-9b83-4f3c-bf38-b03dec180352" |
| article_name | "The champions were defeated" |
| article_slug | "the-champions-were-defeated" |
| section_slug | "sport" |
| title_slug | "weekly-news" |
| title_uid | "2359" |
| publication_date | "2023-03-14" |
| publication_slug | "world-cup-insert" |
| publication_uid | "45680" |
article_narrative_stop
Trigger mechanism
This event is triggered when an article audio file stops playing in a Prenly reader application. The event is triggered when user hits the pause or stop button in the article mode or in the start page's article component, closes the player and when an article audio is automatically reaching the end.
This event is planned to be introduced in all platforms from Q4- 2024.
Event attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| played_duration | Player | int | Time that was played since last start, in seconds |
| playback_position | Player | int | Current playback position in seconds |
| audio_duration | Player | int | The total duration of the audio file, in seconds |
| audio_url | Player | string | The url of the audio file |
| article_uid | Article | string | The unique identifier of the article |
| article_name | Article | string | User-readable article name |
| article_slug | Article | string | Computer-readable article name |
| title_slug | Title | string | Computer-friendly title name |
| title_uid | Title | string | The unique identifier of the title |
| publication_date | Publication | string | Publication date on form YYYY-MM-DD |
| publication_slug | Publication | string | Computer-friendly publication label |
| publication_uid | Publication | string | The unique identifier of the publication |
The attributes with the suffix ? are not always available.
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| played_duration | 54 |
| playback_position | 60 |
| audio_duration | 76 |
| audio_url | “https://epaper.domain.com/audio/articlexxyyzz.mp3 |
| article_uid | "33285619" |
| article_external_id? | "e2b884d5-9b83-4f3c-bf38-b03dec180352" |
| article_name | "The champions were defeated" |
| article_slug | "the-champions-were-defeated" |
| section_slug | "sport" |
| title_slug | "weekly-news" |
| title_uid | "2359" |
| publication_date | "2023-03-14" |
| publication_slug | "world-cup-insert" |
| publication_uid | "45680" |
article_open
Trigger mechanism
This event is triggered when a user opens an article in the article reading mode in a Prenly reader application.
This may occur when:
- an article box is selected in a replica page.
- an article is selected from the search function.
- an article is loaded in the browser with a direct link.
- the user navigates to previous or next article from another article in article reading mode.
Note that the event is triggered as soon as the article is rendered, regardless of whether or not the user is considered having consumed the article content.
Event attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| article_uid | Article | string | The unique identifier of the article |
| article_external_id? | Article | string | Article's unique identifier in an external system |
| article_name | Article | string | User-readable article name |
| article_slug | Article | string | Computer-readable article name |
| section_slug | Article | string | Computer-readable section name |
| title_slug | Title | string | Computer-friendly title name |
| title_uid | Title | string | The unique identifier of the title |
| publication_date | Publication | string | Publication date on form YYYY-MM-DD |
| publication_slug | Publication | string | Computer-friendly publication label |
| publication_uid | Publication | string | The unique identifier of the publication |
The attributes with the suffix ? are not always available.
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| article_uid | "33285619" |
| article_external_id? | "e2b884d5-9b83-4f3c-bf38-b03dec180352" |
| article_name | "The champions were defeated" |
| article_slug | "the-champions-were-defeated" |
| section_slug | "sport" |
| title_slug | "weekly-news" |
| title_uid | "2359" |
| publication_date | "2023-03-14" |
| publication_slug | "world-cup-insert" |
| publication_uid | "45680" |
Deprecated attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| article_id | Article | int | Prenly internal spread id - use article_uid instead |
| title_id | Title | int | Prenly internal title id - use title_uid instead |
| publication_id | Publication | int | Prenly internal publication id - use publication_uid instead |
banner_click
Trigger mechanism
This event is triggered when a user clicks a banner on the start page of a Prenly reader application.
Attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| banner_type | Banner | string | The type of banner (currently always set to custom_link) |
| destination_url | Banner | string | The url being loaded when user clicks the banner |
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| banner_type | "custom_link" |
| destination_url | "https://en.wikipedia.org/wiki/Web_banner" |
custom_tab_audio_start
Trigger mechanism
This event is triggered when an audio file displayed in a custom tab of the Prenly reader is launched in Prenly's audio player with the javascript bridge and is triggered when it starts or resumes.
This is a draft and the event is planned to be introduced in all platforms from Q4, 2024.
Attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| audio_entity_id? | JS-bridge | string | Unique id for the audio |
| audio_title | JS-bridge | string | The title of the audio item |
| audio_url | JS-bridge | string | The url for the audio item |
| playback_position | Player | int | Current playback position in seconds |
| audio_duration? | JS-bridge | int | The duration of the audio file, in seconds |
The attributes with the suffix ? are not always available.
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| audio_entity_id | “external-web-audio-12345” |
| title | “Listen to the latest episode of our podcast” |
| audio_url | “https://external.server.com/path-to-audio-file.mp3” |
| playback_position | 0 |
| audio_duration | 2057 |
custom_tab_audio_stop
Trigger mechanism
This event is triggered when an audio file loaded with the javascript bridge from a custom tab of the Prenly reader is paused or stopped in Prenly's audio player, or when it reaches the end.
This is a draft and the event is planned to be introduced in all platforms from Q4, 2024.
Attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| audio_entity_id? | JS-bridge | string | Unique id for the audio |
| audio_title | JS-bridge | string | The title of the audio item |
| audio_url | JS-bridge | string | The url for the audio item |
| playback_position | Player | int | Current playback position in seconds |
| audio_duration? | JS-bridge | int | The duration of the audio file, in seconds |
| played _duration | Player | int | Time that was played since the last start, in seconds. |
The attributes with the suffix ? are not always available.
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| audio_entity_id | “external-web-audio-12345” |
| title | “Listen to the latest episode of our podcast” |
| audio_url | “https://external.server.com/path-to-audio-file.mp3” |
| playback_position | 350 |
| played_duration | 145 |
| audio_duration | 2057 |
external_url_clicked (deprecated)
Note that this event is deprecated and will be removed in future versions.
Trigger mechanism
This event is triggered when a user open a link to as web page (http or https) that is hosted on an external web site.
This may occur when:
- a box is clicked in a replica publication page, if the box is associated with a url
- a page component of type “banner” is clicked, if the banner is associated with a link
Dimensions
User related dimensions
These dimensions are sent only if a user is logged-in, and if the end-user requires consent from the end-user and the end-user accepted it. See more about user related dimensions.
They are sent in platform-specific structures or format:
| Dimension | Belongs to | Data type | Description |
|---|---|---|---|
| user_id | User | string | User's unique identifier |
| customer_number | User | string | User's unique customer number |
Event related dimensions
| Dimension | Belongs to | Data type | Description |
|---|---|---|---|
| url | User | string | The url to the external web page |
Deprecated dimensions
These dimensions are only sent in native apps and will stopped being sent in the future.
| Dimension | Belongs to | Data type | Description |
|---|---|---|---|
| title_uid | User | string | The unique identifier of the title |
| issue_uid | Title | string | The unique identifier of the publication |
| issue_slug | Title | string | Computer-friendly publication label |
More information about event dimensions is found here.
Example
This is an example of event dimensions passed with the external_url_clicked event.
{ "user_id": "e2b884d5-9b83-4f3c-bf38-b03dec180352", "customer_number": "CK1635", "url": "https://some.site.com/page?foo=bar"}
favorite_title_add
Trigger mechanism
This event is triggered when a user interacts to add a specific title to its list of personal favorites in a Prenly reader application.
Attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| title_slug | Title | string | Computer-friendly title name |
| title_uid | Title | string | The unique identifier of the title |
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| title_slug | "weekly-news" |
| title_uid | "2359" |
Deprecated attributes
These attributes will stopped being sent in the future.
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| title_id | Title | int | Prenly internal title id - use title_uid instead |
favorite_title_remove
Trigger mechanism
This event is triggered when a user interacts to remove a specific title from its list of personal favorites in a Prenly reader application.
Attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| title_slug | Title | string | Computer-friendly title name |
| title_uid | Title | string | The unique identifier of the title |
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| title_slug | "weekly-news" |
| title_uid | "2359" |
Deprecated attributes
These attributes will stopped being sent in the future.
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| title_id | Title | int | Prenly internal title id - use title_uid instead |
issue_open (deprecated)
Note that this event is deprecated and will be removed in future versions.
Trigger mechanism
This event is triggered when a user opens a publication (formerly called issue) in a Prenly reader application, regardless of the publication's default reading mode.
This may occur when:
- a publication is selected from start page loading the first page in the publication.
- a publication is selected from a title page.
- a publication page or spread is selected from the search page.
- a publication (and thereby its first page) is loaded in the browser with a direct link (web reader only).
Dimensions
| Dimension | Belongs to | Data type | Description |
|---|---|---|---|
| user_id | User | string | User's unique identifier |
| customer_number | User | string | User's unique customer number |
| issue_slug | Publication | string | Computer-friendly publication name |
| issue_id | Publication | int | Prenly internal publication id |
| publication_date | Publication | string | Publication date on form YYYY-MM-DD |
| title_slug | Title | string | Computer-friendly title name |
| title_id | Title | int | Prenly internal title id |
More information about event dimensions is found here.
Example
This is an example of event dimensions passed with the issue_open event.
{ "user_id": "e2b884d5-9b83-4f3c-bf38-b03dec180352", "customer_number": "CK1635", "issue_slug": "world-cup-insert", "issue_id": 45680, "publication_date": "2019-12-24", "title_slug": "weekly-news", "title_id": 2359}
podcast_episode_start
Trigger mechanism
This event is triggered when a podcast episode in a Prenly reader starts playing from the beginning, or when a user resumes playing a paused episode.
The values within parenthesis show the source node from the podcast rss file.
This event is planned to be introduced in all platforms from Q4, 2024.
Attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| channel_title | PodcastRSS | string | Title of the podcast channel (channel → title) |
| episode_title | PodcastRSS | string | Title of the episode (channel → item → title) |
| episode_entity_id | PodcastRSS | string | Unique id for the episode (channel → item → guid) |
| channel_slug | PodcastRSS | string | The slug for the channel, included in the url to the podcast channel page |
| publish_date | PodcastRSS | datetime | Publication date for the episode (channel → item → pubDate) |
| playback_position | Player | int | Current playback position in seconds |
| audio_duration? | PodcastRSS | int | The total duration of the podcast episode in seconds (channel → item → itunes:duration) |
| audio_url | PodcastRSS | string | The url of the audio file (channel → item → enclosure url) |
The attributes with the suffix ? are not always available.
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| channel_title | "Du lytter til Politiken” |
| episode_title | "Tre årtier i front: Hvorfor gik vi egentlig i krig? Og var det prisen værd?" |
| episode_entity_id | “politiken-podcast-10087427” |
| channel_slug | “du-lytter-til-politiken” |
| publish_date | 2024-09-27 |
| playback_position | 0 |
| audio_duration | 2057 |
| audio_url | "https://politiken.dk/_binary/podcast/10087427.mp3?n=1727404200000&originArticleId=10087427&premium=false” |
podcast_episode_stop
Trigger mechanism
This event is triggered when a podcast episode in a Prenly reader stops playing.
The event will be triggered when a user presses pause, stop or when the episode reaches its end.
The values within parenthesis show the source node from the podcast rss file.
This event is planned to be introduced in all platforms from Q4, 2024.
Attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| channel_title | PodcastRSS | string | Title of the podcast channel (channel → title) |
| episode_title | PodcastRSS | string | Title of the episode (channel → item → title) |
| episode_entity_id | PodcastRSS | string | Unique id for the episode (channel → item → guid) |
| channel_slug | PodcastRSS | string | The slug for the channel, included in the url to the podcast channel page |
| publish_date | PodcastRSS | datetime | Publication date for the episode (channel → item → pubDate) |
| playback_position | Player | int | Current playback position in seconds |
| audio_duration? | PodcastRSS | int | The total duration of the podcast episode in seconds (channel → item → itunes:duration) |
| audio_url | PodcastRSS | string | The url of the audio file (channel → item → enclosure url) |
| played_duration | Player | int | Time that the episode was played since the last start, in seconds. |
The attributes with the suffix ? are not always available.
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| channel_title | "Du lytter til Politiken” |
| episode_title | "Tre årtier i front: Hvorfor gik vi egentlig i krig? Og var det prisen værd?" |
| episode_entity_id | “politiken-podcast-10087427” |
| channel_slug | “du-lytter-til-politiken” |
| publish_date | 2024-09-27 |
| playback_position | 245 |
| audio_duration | 2057 |
| audio_url | "https://politiken.dk/_binary/podcast/10087427.mp3?n=1727404200000&originArticleId=10087427&premium=false” |
| played_duration | 132 |
prenly_app_open
Trigger mechanism
This event is triggered when a user opens the Prenly native reader application (iOS, Android).
This may occur when:
- the application starts up anew.
- the application is moved into foreground after being placed in the background.
When the application is opened, a consent dialog can be shown if the user has not already given consent. In those cases this event will be triggered after consent has been given.
Attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| push_notifications_enabled | Application | boolean | Whether user has turned on push notifications |
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| push_notifications_enabled | true |
Note that many integrations send boolean values as strings (
"0"or"true"). Please refer to the documentation for each specific integration.
prenly_push_notification_open
Trigger mechanism
This event is triggered when a user opens a push notification that has been sent from Prenly Workspace.
Attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| push_notification_uid | Push notification | string | The unique identifier of the push notification |
| push_notification_sent_at | Push notification | string | The time (in RFC 3339 format) when the push notification was sent from Prenly |
| message_title | Push notification | string | The optional title of the push notification (not currently used) |
| message_body | Push notification | string | The message body of the push notification limited to max 100 characters |
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| push_notification_uid | "87238" |
| push_notification_sent_at | "2023-09-20T07:27:14+00:00" |
| message_title | "Hello!" |
| message_body | "Once upon a time..." |
publication_open
This event was introduced in the web reader from October 2024, and is available from IOS app version 13.0.0 and Android version 12.3.0 (released October 2024).
Trigger mechanism
This event is triggered when a user opens a publication in a Prenly reader application, regardless of the publication's default reading mode.
This may occur when:
- a publication is selected from start page loading the first page in the publication.
- a publication is selected from a title page.
- a publication page or spread is selected from the search page.
- a publication (and thereby its first page) is loaded in the browser with a direct link (web reader only).
- a publication is opened from within a continuous swipe through section
- a publication is opened from the page overview page
Dimensions
| Dimension | Belongs to | Data type | Description |
|---|---|---|---|
| publication_slug | Publication | string | Computer-friendly publication name |
| publication_uid | Publication | string | Prenly internal publication id |
| publication_date | Publication | string | Publication date on form YYYY-MM-DD |
| title_slug | Title | string | Computer-friendly title name |
| title_uid | Title | string | Prenly internal title id |
| limited_access ? | Publication | boolean | (Web only) - indicates if publication is opened with limited access, e.g. with a shared link to or a preview of a certain page or article |
The attributes with the suffix ? are not always available.
More information about event dimensions is found here.
Example
This is an example of event dimensions passed with the publication_open event.
{ "user_id": "e2b884d5-9b83-4f3c-bf38-b03dec180352", "customer_number": "CK1635", "publication_slug": "world-cup-insert", "publication_uid": "45680", "publication_date": "2019-12-24", "title_slug": "weekly-news", "title_uid": "2359", "limited_access: true}
replica_box_link_click
Trigger mechanism
This event is triggered when a user clicks a box on a replica page in a Prenly reader application, if the box is a link that opens an external url when clicked.
Attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| destination_url | Replica box | string | The url of the external link loaded when user clicks the box |
| external_link_id? | Replica box | string | An identifier of the external link, if any |
| title_slug | Title | string | Computer-friendly title name |
| title_uid | Title | string | The unique identifier of the title |
| publication_date | Publication | string | Publication date on form YYYY-MM-DD |
| publication_slug | Publication | string | Computer-friendly publication label |
| publication_uid | Publication | string | The unique identifier of the publication |
| page_number | Replica | int | Page number within the replica |
The attributes with the suffix ? are not always available.
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| destination_url | "https://en.wikipedia.org/wiki/Hyperlink" |
| external_link_id | "some-identifier" |
| title_slug | "weekly-news" |
| title_uid | "2359" |
| publication_date | "2019-12-24" |
| publication_slug | "world-cup-insert" |
| publication_uid | "45680" |
| page_number | 17 |
replica_box_link_view
This event was introduced in the web reader from October 2024, and is available from IOS app version 13.0.0 and Android version 12.3.0 (released October 2024).
Trigger mechanism
This event is triggered when a replica page in a Prenly reader application is displayed, if a box with a clickable link to an external url is included in the page. The purpose of this event is mainly to track the number of ad impressions, but it can also be used to track impressions of other kinds of clickable objects.
Attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| destination_url | Replica box | string | The url of the external link included in the box |
| external_link_id? | Replica box | string | An identifier of the external link, if any (optional) |
| title_slug | Title | string | Computer-friendly title name |
| title_uid | Title | string | The unique identifier of the title |
| publication_date | Publication | string | Publication date on form YYYY-MM-DD |
| publication_slug | Publication | string | Computer-friendly publication label |
| publication_uid | Publication | string | The unique identifier of the publication |
| page_number | Replica | int | Page number within the replica |
The attributes with the suffix ? are not always available.
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| destination_url | "https://en.wikipedia.org/wiki/Hyperlink" |
| external_link_id | "some-identifier" |
| title_slug | "weekly-news" |
| title_uid | "2359" |
| publication_date | "2019-12-24" |
| publication_slug | "world-cup-insert" |
| publication_uid | "45680" |
| page_number | 17 |
replica_page_open
Trigger mechanism
This event is triggered when a user opens a replica page in a Prenly reader application, using the replica reading mode.
This may occur when:
- a publication is selected from start page loading the first page in the publication.
- a publication page or spread is selected from the search page.
- the user navigates to previous or next page in replica reading mode.
- the user navigates to previous or next spread (normally two pages) in replica reading mode.
- a page or a spread is loaded in the browser with a direct link (web reader only).
- a link to the Prenly reader application is opened on an iOS or Android device, for example from an e-mail or on another web page.
When a spread (two or more adjacent pages) is rendered, all pages on the spread will trigger its own replica_page_open event.
Note that the event is triggered as soon as the page is rendered, regardless of whether or not the user is considered having consumed any page content.
Attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| title_slug | Title | string | Computer-friendly title name |
| title_uid | Title | string | The unique identifier of the title |
| publication_date | Publication | string | Publication date on form YYYY-MM-DD |
| publication_slug | Publication | string | Computer-friendly publication label |
| publication_uid | Publication | string | The unique identifier of the publication |
| part_slug | Replica | string | Computer-friendly label for the publication part |
| page_number | Replica | int | Page number within the replica |
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| title_slug | "weekly-news" |
| title_uid | "2359" |
| publication_date | "2019-12-24" |
| publication_slug | "world-cup-insert" |
| publication_uid | "45680" |
| part_slug | "part-1" |
| page_number | 17 |
Deprecated attributes
These attributes will stopped being sent in the future.
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| title_id | Title | int | Prenly internal title id - use title_uid instead |
| publication_id | Publication | int | Prenly internal publication id - use publication_uid instead |
| spread_id | Replica | int | Prenly internal spread id |
title_open
Trigger mechanism
This event is triggered when a user opens the title page in a Prenly reader application. This page presents information regarding - and possibly content from - one specific title within the application.
Event attributes
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| title_slug | Title | string | Computer-friendly title name |
| title_uid | Title | string | The unique identifier of the title |
Note that contextual data will normally be included when an event is exported.
Example
| Attribute | Example value |
|---|---|
| title_slug | "weekly-news" |
| title_uid | "2359" |
Deprecated attributes
These attributes will stopped being sent in the future.
| Attribute | Belongs to | Data type | Description |
|---|---|---|---|
| title_id | Title | int | Prenly internal title id - use title_uid instead |
titles_overview_open
Trigger mechanism
This event is triggered when a user opens the titles overview page in a Prenly reader application. This page gives the reader an overview of the titles within the application.
Event attributes
This event do not currently have any event attributes.
Note that contextual data will normally be included when an event is exported.