Event dimensions

Art. no. 216207837

User related dimensions

Note that both these dimensions, if set, may be encrypted according to the configuration. Read more below.

Dimension	Data type	Description	Example
user_id	string	The user's unique user identifier	“33213879621”
customer_number	string	The user's unique customer number	“FR-3486”

User identifier origin

Prenly support two different properties identifying the currently logged-in user: user_id and customer_number. They originate from the login system (that we denote authority) that was used to authenticate and authorize the user, so the format of the values may differ. Note that these dimensions are always strings, even if an external system provide integers.

The authority set up for the application declares:

Whether Prenly handles these properties at all.
If handled, whether Prenly handles only one of them or both.
If handled, whether they are included as dimensions in usage statistics events.

Contact our helpdesk if uncertain about what properties are supported by your authority.

Granular configuration

Some authorities support configuring (per integration or application) how these properties are transformed into event dimensions. For each of those two properties, you can choose:

Not to include at all.
Include as-is (unencrypted).
Include in an encrypted form that can later be decrypted in a safe environment.

The configuration allows choosing different behaviour for web reader and native reader.

Currently, these authorities support this selection:

Prenly remote API
Tulo/Payway
Some custom customer-specific authorities

Consent related dimensions

For some statistics modules, it is possible to add information about the consent that the user granted in the consent dialog provided by a CMP (consent management provider).

Consent by purpose

All CMP:s supported by Prenly allows the user to grant consent by purpose. Some of these CMP:s support defining a number of purposes, but Prenly only support three purposes, namely the analytical, functional and marketing purposes. The choices that the user makes in the CMP dialog are transformed to the Prenly supported purposes and each purpose will be either granted, or not granted, by the user.

A value of true (or “1”) means that the purpose was granted. A value of false (or “0”) means that the purpose was not granted.

consent_analytical
Data type	boolean
Example	true (some statistical modules send “1”)
Description	Whether the user granted processing personal data for the analytical purpose

consent_functional
Data type	boolean
Example	true (some statistical modules send “1”)
Description	Whether the user granted processing personal data for the functional purpose

consent_marketing
Data type	boolean
Example	false (some statistical modules send “0”)
Description	Whether the user granted processing personal data for the marketing purpose

consent_services
Data type	string (JSON)
Example	{"google":false, "meta":true, "c:6719980":false}
Description	A JSON string indicating the user's consent for individual services/vendors being used. Each key represents a service identifier, as defined by the CMP module, with a value of `true` or `false` reflecting consent status

Consent by service/vendor

In some CMP:s supported by Prenly, the user can do more granular selections and grant consent to specific third-party companies or services. If so, a purpose is considered granted only if all services within the purpose have been granted.

No specific information regarding consent given per service is currently included in statistics.

Content related dimensions

These dimensions relate to the content being referred to.

Title-specific dimensions

The title concept is further explained here.

title_uid
Data type	string
Example	“19221”
Description	The unique identifier of the title.

title_slug
Data type	string
Example	"daily-news"
Description	A computer-friendly title name as a Prenly slug, based on the title name as setup in Prenly Workspace.

Publication-specific dimensions

The publication concept is further explained here.

publication_uid
Data type	string
Example	“542204”
Description	The unique identifier of the publication.

publication_slug
Data type	string
Example	“world-cup-insert”
Description	A computer-friendly publication name as a Prenly slug, based on the publication name as set in Prenly Workspace.

publication_date
Data type	string (on the form “YYYY-MM-DD”)
Example	“2019-12-24”
Description	The publication date as set in Prenly Workspace. The publication date normally denotes the day when the publication (or its printed equivalent) is first regarded to be published or released. This publication date can for different reasons differ from the date when the publication is actually made available in Prenly, e.g. if: a daily newspaper is published in Prenly the night before the publication date. a publication is published in Prenly some time after it was physically distributed. an archive of publications is made available in Prenly.

publication_date

Data type

string (on the form “YYYY-MM-DD”)

Example

“2019-12-24”

Description

The publication date as set in Prenly Workspace. The publication date normally denotes the day when the publication (or its printed equivalent) is first regarded to be published or released.

This publication date can for different reasons differ from the date when the publication is actually made available in Prenly, e.g. if:

a daily newspaper is published in Prenly the night before the publication date.
a publication is published in Prenly some time after it was physically distributed.
an archive of publications is made available in Prenly.

Article-specific dimensions

The article concept is further explained here.

article_uid
Data type	string
Example	“108762”
Description	The unique identifier of the article.

article_name
Data type	string
Example	"Fire in Råslätt"
Description	A human-friendly article name as set in Prenly Workspace. This is often - but not necessarily - the main heading of a newspaper article or some other document.

article_slug
Data type	string
Example	"fire-in-raslatt"
Description	A computer-friendly article name as a Prenly slug, based on the article name as set in Prenly Workspace.

article_external_id
Data type	string
Example	"ART4562-XZZ"
Description	A unique article reference that is imported from an external system.

Section-specific dimensions

The section concept is further explained here.

section_slug
Data type	string
Example	"noje"
Description	The name of the news section that an article belongs to, as a Prenly slug based on the news section name as set in Prenly Workspace.

Replica-specific dimensions

These dimensions relate to the content being referred to, but only in replica reading mode.

The replica concept is further explained here.

page_number
Data type	int
Example	6
Description	The page number within the replica.

part_slug
Data type	string
Example	"part-c"
Description	The part name that a page belongs to, as a Prenly slug. This value denotes the part as set in Prenly Workspace. This value is normally set when importing content from an external content system, i.e. Textalk Webarch.

Replica box-specific dimensions

These dimensions relate to a box on a page in replica reading mode.

external_link_id
Data type	string
Example	ad-34897
Description	An identifier of an external link, that allows to match the link to external entities, for example ads, crossword ids or any other kind of context. This id can be extracted when Prenly imports publication pages with boxes.

Banner-specific dimensions

These dimensions relate to a start page banner.

banner_type
Data type	string
Example	custom_link
Description	The type of the banner. Currently only the type `custom_link` is implemented, but more types may be implemented.

Other dimensions

Various dimensions that may be used in multiple events.

Dimension	Data type	Description	Example
external_url	string	A valid url that link to a web page (i.e. the http or https protocol). Other uris/urls such as a “com.some.app://foo/bar/” or "mailto:some@email.com” are not currently supported.	“https://foo.com/bar”
destination_url	string	A valid url that link to a web page (i.e. the http or https protocol). Other uris/urls such as a “com.some.app://foo/bar/” or "mailto:some@email.com” are not currently supported.	“https://foo.com/bar”

Deprecated dimensions

These dimensions are deprecated and should not be used. They will be removed in the future.

Dimension	Data type	Description	Example
title_id	int	A unique identifier of a title, used by Prenly internally.	19221
publication_id	int	A unique identifier of a publication, used by Prenly internally.	542204
article_id	int	A unique identifier of an article, used by Prenly internally.	108762
spread_id	int	A unique identifier of the article, used by Prenly internally. A spread is a collection of pages in a printed publication, normally a pair of faced pages (left and right).	732210