Visiolink main events specification (Apps)

2023-04-24 09:32:55 UTC

At Visiolink we have specified 12 events that is key data for your epaper application. Together with the events we have defined parameters and user properties that provide additional information to the events. Below you will get an overview of all 12 events and which parameters that follows and the 5 user properties we have defined.  

User Properties:

User properties are events that hardly ever change value and stay the same across a session and events. The above listed properties can be sent together with all custom events.

User property code:

Description

Example

vl_value_client

Operating system – Platform

iOS

vl_value_version

App version

1.2.0_3.22.0

vl_value_app_id

Bundle id/package id

dk.visiolink-ereader

vl_value_user_id

Id from sso or auto generated id

632259

vl_value_push_token

Unique id from each app download

458964-265445-786421

12 events:

  • Download - vl_event_download
    Trigger the first time a user opens a specific publication. The download even can only be triggered once per publication for a user, unless the user deletes the publication and download it again.

Parameter code:

Description

Example

vl_value_publication_customer

Publication prefix

Hahamburg

vl_value_publication_folder_id

Publication folder id

20235

vl_value_publication_id

Publication ID

43

vl_value_download_authentication_type

 

Login type

Subscription

vl_value_publication_title

Title

Visiolink Abendblatt – 23.01.2023

Vl_value_publication_date

Date

23.01.2023

  • Publication (Opening) - vl_event_publication
    Trigger every time a publication is opened. Therefore, the opening event register every opening of a specific publication.

Parameter code:

Description

Example

vl_value_publication_customer

Publication prefix

Hahamburg

vl_value_publication_folder_id

Publication folder id

20235

vl_value_publication_id

Publication ID

43

vl_value_publication_title

Title

Hamburger Abendblatt
– 23.01.2023

vl_value_publication_source

Publication opened from?

Archive

  • Page Views - vl_event_page
    Trigger every time a page is shown and/or closed. If a user sees two pages in one view both pages will be triggered and sent.

Parameter code:

Description

Example

vl_value_publication_customer

Publication prefix

Hahamburg

vl_value_publication_folder_id

Publication folder id

20235

vl_value_publication_id

Publication ID

43

vl_value_publication_title

Title

Hamburger Abendblatt – 23.01.2023

vl_value_page_number

Page number

24

vl_value_section_number

Section number

2

Vl_value_section_name

Section name (xml)

Supplement

vl_value_orientation

Orientation of screen

Portrait

vl_value_duration

Time spent on a page

33 (sec)

*Duration only sends a value if a user spends more than 2 secs on the page. If a user zooms or click on an article then the timer will stop.

  • Article - vl_event_article_end
    Article event is triggered when a user clicks, pans, pinch, swipe or otherwise navigates on an article.

Parameter code:

Description

Example

vl_value_publication_customer

Publication prefix

Hahamburg

vl_value_publication_folder_id

Publication folder id

20235

vl_value_publication_id

Publication ID

43

vl_value_publication_title

Title

Hamburger Abendblatt – 23.01.2023

vl_value_article_page_number

Page number

6

vl_value_article_title

Article Title

Visiolink take over

vl_value_article_category

Category

Local

vl_value_article_external_id

 

Article id

63251

vl_value_article_source

Article opened from?

Frontpage

vl_value_article_method

How is article read

Pan

Vl_value_section_number

Section number

2

vl_value_duration

Time spent on article (sec)

341

vl_value_orientation

Orientation of screen

Landscape

  • Audio articles – vl_event_audio_end
    The Audio event is triggered when a user plays an audio article.

Parameter code:

Description

Example

vl_value_publication_customer

Publication prefix

Hahamburg

vl_value_publication_folder_id

Publication folder id

20235

vl_value_publication_id

Publication ID

43

vl_value_publication_title

Title

Visiolink Abendblatt – 23.01.2023

vl_value_article_page_number

Page number

6

vl_value_article_title

Article Title

Visiolink take over

vl_value_article_category

Category

Local

vl_value_article_external_id

 

Article id

63251

vl_value_audio_source

Audio article played from?

Article View

vl_value_audio_length

Length of audio article (only for GC tts)

351 (sec)

vl_value_duration

Time spent on article

158 (sec)

vl_value_audio_article_type

Type of audio Article

GC TTS (google cloud)

vl_value_article_character_count

Article characters
*Only for device tts

6985

  • Podcast – vl_event_podcast_end
    The Podcast event is triggered when a user plays a podcast.

Parameter code:

Description

Example

vl_value_podcast_title

Podcast title

News from Visiolink

vl_value_podcast_channel

Podcast channel

Visiolink Podcast

vl_value_podcast_length

Podcast length

978 (sec)

vl_value_podcast_author

Podcast Author

Visiolink

vl_value_podcast_source

Where is the podcast played from?

Podcast

vl_value_duration

Time spent on podcast

566 (sec)

  • Search – vl_event_search
    The search event is triggered when a user searched for content and gets a result

Parameter code:

Description

Example

vl_value_search_query

Search word

Visiolink

vl_ value_search_scope

Search place

Archive, Local or Current

  • Interstitial Impression – vl_event_interstitial_impression
    The interstitial event is triggered every time a user swipes to an interstitial. Every time it is viewed it sends an impression.

Parameter code:

Description

Example

vl_value_publication_customer

Publication prefix

Hahamburg

vl_value_publication_folder_id

Publication folder id

20235

vl_value_publication_id

Publication ID

43

vl_value_interstital_id

Interstitial name from the hub

Sign up here

  • Interstitial Click – vl_event_interstitial_click
    The interstitial event is triggered every time a user clicks on an interstitial. Every time it is clicked it sends an interstitial click.

Parameter code:

Description

Example

vl_value_publication_customer

Publication prefix

Hahamburg

vl_value_publication_folder_id

Publication folder id

20235

vl_value_publication_id

Publication ID

43

vl_value_interstital_id

Interstitial name from the hub

Sign up here

  • Hotspot Impression – vl_event_hotspot_impression
    The Hotspot event is triggered when a user swipes/views a page that has a hotspot. If a page has multiple hotspots an impression is send for each hotspot.

Parameter code:

Description

Example

vl_value_publication_customer

Publication prefix

Hahamburg

vl_value_publication_folder_id

Publication folder id

20235

vl_value_publication_id

Publication ID

43

vl_value_hotspot_id

Clickable ad url

www.visiolink.com

Vl_value_page_number

Page number

4

  • Hotspot click – vl_event_hotspot_click
    The Hotspot click event is triggered when a user clicks on a hotspot.

Parameter code:

Description

Example

vl_value_publication_customer

Publication prefix

Hahamburg

vl_value_publication_folder_id

Publication folder id

20235

vl_value_publication_id

Publication ID

43

vl_value_hotspot_id

Clickable ad url

www.visiolink.com

Vl_value_page_number

Page number

4

  • Module Interaction – vl_event_module_interaction
    The module event is triggered every time a user clicks on content on the frontpage.

Parameter code:

Description

Example

vl_value_module_name

Name of the module from the app

Podcast

Orientation

Orientation of screen

Landscape or Portrait

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments