Data Model Structure

Composer

composer.conversion

Event that specifies the visitor responded to your call-to-action. As a composer conversion, we understand, for example, AdBlock disablement, credit redeemed, etc.

Composer

experience.action

Event that specifies the visitor was exposed/targeted by the template/offer. Please note, only the ShowTemplate or ShowOffer action cards are captured. If a template is shown by the function tp.template.show() within a Run JS action card, it is not taken into account. Additionally, the event contains experience action when it is logged via exposure API with “SendToCI” parameter.

Composer

experience.interaction

Event that specifies the visitor clicked on the template. Piano automatically logs every external link clicked inside our templates. "Close" button clicks are excluded.

Composer and VX

page.display

Event indicating a page has been displayed on-site or on a mobile/App screen. This event is essential to measure traffic correctly and is the origin of the "Page Views" metric.

Composer/Identity

identity.form.exposure

Event is generated when there is a form being exposed to a visitor in Composer experience.

Composer/Identity

identity.form.submit

Event is generated when a visitor submits the form with responses.

Identity

identity.create

Identity create event is generated when a user creates a new account either within the checkout flow or through the signup method. The event is also created when the publisher creates new accounts through the support team or bulk creation when migrating/importing users.

Identity

identity.delete

Identity delete is generated when a user account is removed from the system.

Identity

identity.email.submit

Event is being generated only when the client is using the Double Opt-In feature in ID and a customer submits the email address on registration but it is not confirmed yet.

Identity

identity.login

Identity login event is generated when users log in on the website to their account.

Identity

identity.logout

Identity logout event is generated when users log out of the website from their account.

Identity

identity.password.reset.requested

Identity password reset request is generated when users forget their password and request a reset through an email link.

Identity

identity.password.reset.success

Identity password reset success is generated when users successfully create a new password after the identity password reset request.

Identity

identity.password.updated

Identity password update is generated each time a password is updated—either via account management or password reset request.

Identity

identity.session.expire

Identity session expired is generated when a user is logged out from their account due to an expired session and is forced to log in again.

VX

subscription.action

Event that specifies a change in subscription behavior. The change is done "on-site". For example, a subscription has been upgraded, or a user enabled auto-renewal in My Account, etc.

VX

subscription.action.offsite

Event that specifies a change in subscription behavior. The change is done "off-site" with the help of the customer helpdesk or automatically by the system, etc. For example, a subscription has been upgraded, or auto-renewal has been updated via the helpdesk.

VX

transaction.refund.offsite

Event that specifies the previously successful monetary transaction has been refunded. It can be a partial refund, full refund, etc. Refund is done automatically by the system or in an "off-site" way.

VX

vx.conversion

Event that specifies the visitor responded to your call-to-action. If you’re using Piano VX to show offers, a visitor accepting any term within that offer (by paying, registering, etc.) will automatically register as a conversion. Included are specifically "on-site" events. As a VX conversion, we understand, for example, payment term converted, free promo redeemed, the voucher purchased, etc.

VX

vx.conversion.offsite

Event that specifies the visitor responded to your call-to-action but it is done in an "off-site" way, for example, by the customer helpdesk. As a VX offsite conversion, we understand, for example, payment/registration term conversion done by the customer helpdesk, etc.

PRODUCT

NAME

PROPERTY KEY

PROPERTY FORMAT

DESCRIPTION

Composer

ab_test_card_title

A/B test name

string

A/B test name is filled when the experience action event is part of the A/B test in the Composer experience

Composer

ab_test_variant_name

A/B test variant name

string

A/B test variant name is filled when the experience action event is part of the A/B test in the Composer experience

Composer

api_interaction_card_id

API interaction card ID

string

ID of the Composer card that was executed prior to the page load as a part of API interaction experience.

Composer

api_interaction_card_name

API interaction card name

string

Name of the Composer card that was executed prior to the page load as a part of API interaction experience.

Composer

api_interaction_card_type

API interaction card type

string

Type of the Composer card that was executed prior to the page load as a part of API interaction experience.

Composer

api_interaction_experience_id

API interaction experience ID

string

ID of the Composer API interaction experience that was executed prior to the page load.

Composer

api_interaction_experience_name

API interaction experience name

string

Name of the Composer API interaction experience that was executed prior to the page load.

Composer

api_interaction_experience_type

API interaction experience type

string

Type of the Composer API interaction experience that was executed prior to the page load.

Composer

api_interaction_experience_outcome

API interaction experience outcome

string

Outcome of the Composer API interaction experience that was executed prior to the page load.

Composer

browser_id (not visible by the client)

Browser ID

string

Identifier of a visitor within Composer. Information within the \"event\" scope (several possible values per visit).

Composer

c1x_brand_relationship

C1x- Brand relationship

string

Segment definition of visitor from C1x segmentation engine: Registered Users, Gift Recipients, Free Trial Users, Paid Trial users, Subscribers, Churned Users. Segment values are populated only if the segment is used in live Composer experience

Composer

c1x_checkout_abandonment

C1x- Checkout abandonment

string

Segment of users that have entered the purchase funnel, but have not completed a transaction: Abandoned checkout in the last 48 hours, Abandoned checkout in the last 7 days, Abandoned checkout in the last 30 days. Segment values are populated only if the segment is used in live Composer experience

Composer

c1x_content_likely_to_convert

C1x- Content Likely to Convert

string

Machine learning model predicts which articles are the most likely to drive subscription conversions with propensity scores between 0 and 100%. This score is defined by C1x segmentation engine.

Composer

c1x_expiring_subscribers

C1x- Expiring subscribers

string

Users who have disabled the automatic renewal of their subscription payment, and who will terminate their subscription upon the subscription end date and users whose subscription failed upon the renewal and are in grace period. Segment values are populated only if the segment is used in live Composer experience

Composer

c1x_likelihood_to_register

C1x- Likelihood to Register

string

Group of visitors based on a propensity score between 0 and 100% predicting a visitor's likelihood to register on the website. This score is defined by C1x segmentation engine.

Composer

c1x_likelihood_to_return

C1x- Likelihood to Return

string

Group of visitors based on a propensity score between 0 and 100% predicting a visitor's likelihood of being amongst the most loyal user to a website over the next week. This score is defined by C1x segmentation engine.

Composer

c1x_ltc

C1x- Likelihood to cancel

string

Group of subscribers based on a propensity score between 0 and 100% predicting a subscription cancellation (100% is the most likely to cancel). This score is defined by C1x segmentation engine.

Composer

c1x_lts

C1x- Likelihood to subscribe

string

Group of non-subscribers based on a propensity score between 0 and 100% predicting a subscription (100% is the most likely to subscribe). This score is defined by C1x segmentation engine.

Composer

c1x_revenue_auto_optimization

C1x- Dynamic paywall

string

The Dynamic Paywall model is optimizing two key revenue streams: advertising and subscription revenue. The model’s data are breaking down pageviews into 20 distinct segments. The segment value 0 represents the top 5% of pageviews with the highest propensity to be monetized by subscription. Each next segment increments 5% of the pageviews volume

Composer

c1x_subscription_length

C1x- Subscription Length

string

Segment of users based on the terms of their subscription. The segments from this category range: Weekly Subscribers, 4-week subscribers, Monthly subscribers, Quarterly subscribers, Bi-annual subscribers, Annual subscribers. Segment values are populated only if the segment is used in live Composer experience

Composer

c1x_subscription_tenure

C1x- Subscription tenure

string

Segment of users based on the amount of time they have been actively subscribed to the product. Segment values: First 24 hour subscribers, Week 1 subscribers, Week 2 subscribers, Week 3 subscribers, Week 4 subscribers, Month 1-2 subscribers, Month 3-6 subscribers, Month 6+ subscribers. Segment values are populated only if the segment is used in live Composer experience

Composer

c1x_visitor_frequency

C1x- User frequency

string

Segment of visitors based on their visit frequency (number of days with visits): 1 visit day last month, 2 visit days last month, 3-4 visit days last month, 5-9 visit days last month, 10+ visit days last month. Here, “Last month” means “last 30 days” based on the measurement date. Segment values are populated only if the segment is used in live Composer experience

Composer

c1x_visitor_interest

C1x- Visitor interest

array string

The User Interest segment category consists of machine learning generated segments based on the types of content users consume, to segment users based on the type of articles they read most often, and how much they read compared to others reading similar types of content. The 29 interest categories are based on the standard industry taxonomy provided by the IAB organization. Segment values are populated only if the segment is used in live Composer experience

Composer

c1x_visitor_recency

C1x- Visitor recency

string

Segments of visitors by the time since they last visited the site: Active last 24 hours, Active last 1-2 days, Active last 3-7 days, Active last 8-14 days, Active last 15+ days. Segment values are populated only if the segment is used in live Composer experience

Composer

card_action

Card action

string

Type of the card action within a specific Composer experience (\"Show template\", \"Show offer\", \"Show newsletter signup\", \"Show recommendations\", etc.).

Composer

card_id

Card ID

string

Identifier of an action card within a specific Composer experience.

Composer

card_name

Card name

string

Name of the card within a specific Composer experience.

Composer

content_authors

Content author

string

The person who writes the article.

Composer

content_publication_date

Content publication date

Date time

Article publish date. This attribute provides the date and time of the creation of the given content. The time given is Coordinated Universal Time (UTC).

Composer

content_section

Content section

String

A section is a collection of pages that get defined based on the publisher structure under the content of the article.

Composer

conversion_id

Conversion ID

string

Identifier of a conversion. Conversion is a desirable action taken by the visitor. The conversion itself is not a monetary action.

Composer

DEPRECATED term_name_v5

Term name

array string

Name of the term. Terms are the specifics of the deal you're striking with your audience. They define what a customer is giving you in return for access as well as how long that access lasts.

Composer

exp_interaction_type

Interaction type

array string

Interaction type specifies a visitor's behavior when an element is clicked. Unlike a simple href, which you'd use to create links to external pages, this directive can be used with Piano's custom Angular JS functions. For example, ng-click is commonly used to attach Piano's startCheckout method to the buttons used for selecting terms.

Composer

experience_execution_id

Experience Execution ID

string

The internal ID that relates to the concrete execution of the experience

Composer

experience_exposed

Is experience exposed?

boolean

Is set to TRUE in case the template/offer is loaded on the page.

Composer

experience_id

Experience ID

string

Identifier of the Composer experience.

Composer

experience_name

Experience name

string

Name of the Composer experience.

Composer

experience_type

Experience type

string

Type of experience that can be created in Composer.

Composer

experience_version

Experience version

string

Version of the Composer experience.

Composer

global_experience_id

Global experience ID

string

Identifier of the global experience. Global experience allows the client management and creation of cross-app Composer experience(s), so the client is not required to switch between dozens of apps to make changes.

Composer

global_experience_name

Global experience name

string

Name of the global experience. Global experience allows the client management and creation of cross-app Composer experience(s), so the client is not required to switch between dozens of apps to make changes.

Composer

has_access

Has access?

array string

Information about whether the visitor has access to any content. Is set to TRUE if the visitor has gained access to any resources via completion of any term (payment, registration, etc.).

Composer

has_access_to

Has access to

Array object

The list of terms & resources which the visitor has access to.

Composer

has_access_to:has_access_to_resource_id

Has access to Resource ID

Sub-object (string)

Resource ID which the visitor has access to. Visitor can gain access to any resource via completion of any term (payment, registration, etc.).

Composer

has_access_to:has_access_to_resource_name

Has access to Resource name

Sub-object (string)

Resource name which the visitor has access to. Visitor can gain access to any resource via completion of any term (payment, registration, etc.).

Composer

has_access_to:has_access_to_term_id

Has access to Term ID

Sub-object (string)

Term ID which the visitor has access to. Visitor can gain access to any resource via completion of any term (payment, registration, etc.).

Composer

has_access_to:has_access_to_term_name

Has access to Term name

Sub-object (string)

Term name which the visitor has access to. Visitor can gain access to any resource via completion of any term (payment, registration, etc.).

Composer

has_access_to:has_access_to_term_type

Has access to Term type

Sub-object (string)

Term type which the visitor has access to. Visitor can gain access to any resource via completion of any term (payment, registration, etc.).

Composer

meter_card_name

Meter card name

array string

Name of the pageview meter card within a specific Composer experience. Pageview meter card provides the client with the ability to give visitors a glimpse of the content by allowing a limited number of article views, sessions, or visit days per month.

Composer

page_card_name

Pages card name

string

Name of the very first card within a specific Composer experience. Effective pages card determines which web pages on the client site a given experience can fire on.

Composer

page_content_type

Content type

String

Content type of page such as article, frontpage, etc.

Composer

pageview_id

Pageview ID

string

Identifier of page view. Information within the \"event\" scope (several possible values per visit).

Composer

publisher_aid

Publisher AID

string

Identifier of the Piano application.

Composer

segment_path

Segment path

array string

Names of the user segment cards within a specific Composer experience in sequence. User segment card provides the client with the ability to target specific audience segments with unique offers and custom experiences.

Composer

tags_array

Tags

array string

Freely definable tags for the page, as provided by the publisher.

Composer

template_closable

Template closable?

boolean

Is set to TRUE in case the close button is shown on the template. Is set to FALSE in case it is not.

Composer

template_display_mode

Template display mode

string

Information about whether the display mode of the template is inline or modal.

Composer

template_id

Template ID

string

Identifier of the template. Template is what a visitor sees during checkout.

Composer

template_name

Template name

string

Name of the template. Template is what a visitor sees during checkout.

Composer

template_variant_id

Template variant ID

string

Identifier of the template variant. Template variant is an iteration of the template that inherits all of their HTML/CSS, and allows for changes via content fields. A single template may have none, one, or multiple variants.

Composer

template_variant_name

Template variant name

string

Name of the template variant. Template variant is an iteration of the template that inherits all of their HTML/CSS, and allows for changes via content fields. A single template may have none, one, or multiple variants.

Composer

term_offer_id

Offer ID

string

Identifier of the offer. An offer is a collection of terms. Each offer can combine terms of different types.

Composer

term_offer_name

Offer name

string

Name of the offer. An offer is a collection of terms. Each offer can combine terms of different types.

Composer

user_brand_relationship

C1x - Current brand relationship (user)

string

Current segment definition of visitor from C1x segmentation engine: Registered Users, Gift Recipients, Free Trial Users, Paid Trial users, Subscribers, Churned Users.

Composer

user_expiring_subscribers

C1x - Currently expiring subscribers (user)

string

Current users who have disabled the automatic renewal of their subscription payment, and who will terminate their subscription upon the subscription end date.

Composer

user_likelihood_to_cancel

C1x- Current likelihood to cancel (user)

string

Propensity score predicting a subscription cancellation to which the user currently belongs (between 0 and 100%, 100% is the most likely to cancel). This score is defined by C1x segmentation engine.

Composer

user_subscription_length

C1x - Current subscription length (user)

string

Current segment of users based on the terms of their subscription. The segments from this category range: Weekly Subscribers, 4-week subscribers, Monthly subscribers, Quarterly subscribers, Bi-annual subscribers, Annual subscribers.

Composer

user_subscription_tenure

C1x - Current subscription tenure (user)

string

Current segment of users based on the amount of time they have been actively subscribed to the product. Segment values: First 24 hour subscribers, Week 1 subscribers, Week 2 subscribers, Week 3 subscribers, Week 4 subscribers, Month 1-2 subscribers, Month 3-6 subscribers, Month 6+ subscribers.

Composer and VX

term

Term

Array object

Terms are the specifics of the deal you're striking with your audience. They define what a customer is giving you in return for access as well as how long that access lasts.

Composer and VX

term_id

Term ID

Sub-object (string)

ID of the term. Terms are the specifics of the deal you're striking with your audience. They define what a customer is giving you in return for access as well as how long that access lasts.

Composer and VX

term_name

Term Name

Sub-object (string)

Name of the term. Terms are the specifics of the deal you're striking with your audience. They define what a customer is giving you in return for access as well as how long that access lasts.

Composer and VX

term_type

Term Type

Sub-object (string)

Type of the term. Terms are the specifics of the deal you're striking with your audience. They define what a customer is giving you in return for access as well as how long that access lasts.

Composer/Identity

pid_form_field

Form fields

array object

List of custom fields of the Piano Identity form used in Composer experience to collect zero party data or churn reason in the context of Active churn prevention.

Composer/Identity

pid_form_field:pid_form_field_id

Field ID

string (subproperty)

ID of the custom field in the Piano Identity form used in Composer experience to collect zero party data or churn reason in the context of Active churn prevention.

Composer/Identity

pid_form_field:pid_form_field_title

Field Title

string (subproperty)

Title of the custom field in the Piano Identity form used in Composer experience to collect zero party data or churn reason in the context of Active churn prevention.

Composer/Identity

pid_form_field:pid_form_field_value

Field Value

string (subproperty)

Submitted value of the custom field by visitor in the Piano Identity form used in Composer experience to collect zero party data or churn reason in the context of Active churn prevention. 

Composer/Identity

pid_form_id

Form ID

string

ID of the Piano Identity form used in Composer experience to collect zero party data or churn reason in the context of Active churn prevention.

Composer/Identity

pid_form_title

Form name

string

Name of the Piano Identity form used in Composer experience to collect zero party data or churn reason in the context of Active churn prevention.

Identity

pid_double_optin

Identity - Double opt-in

string

For the Double opt-in feature two values: "Email submit" for the initial step to generate a passwordless confirmation email and "Email confirmed" when clicking on a link in the email to submit a new account creation.

Identity

pid_event_source

Identity - Event Source

string

The source of the event that is coming from one of the sources: Any, Publisher, Customer, Social

Identity

pid_passwordless

Identity - Passwordless enabled

boolean

Data point to identify the enablement of the passwordless method by the user.

Identity

pid_social_signin

Identity - Social Sign-in method

string

If the user is using a social sign-in method. Values: EMAIL, FACEBOOK, GOOGLE, LINKEDIN, TWITTER, APPLE

VX

billing_country_code

Billing country code

string

Short code representing the country or dependent area associated with the transaction. Can be empty if taxes are not configured for the application.

VX

billing_index

Billing index

integer

Ordinal index of the billing period from the start of the subscription across all access periods that have already passed

VX

billing_period

Billing period

string

Information on the duration of the period of a subscription not taking trial into account (1 month, 1 year, etc.).

VX

billing_period_count

Billing period count

integer

Ordinal number of renewals within one access period

VX

created_via_upgrade

Created via upgradec?

boolean

Is set to TRUE in case the subscription was created upon an upgrade to a different term (e.g. from a monthly to an annual subscription). Is set to FALSE in case there was no upgrade.

VX

external_api_source

External API source

string

Is in use for externally verified term conversions/renewals. An external API source specifies a connection to an external database.

VX

is_full_refund

Is full refund?

boolean

Is set to FALSE in case the refunded amount is lower than the original amount, in other words, in case of a partial refund. Is set to TRUE in case of a full refund.

VX

is_in_trial

Is in trial?

boolean

Is set to TRUE in case the subscription is in a free/paid trial period. Is set to FALSE in case the subscription is out of the trial period, or if there is no trial associated with the subscription.

VX

licensee_id

Licensee ID

string

Identifier of the site license. Site licensing allows any users associated with the contract to redeem access to the client´s site by visiting a landing page and registering. The site license has specified a resource to which access is provided, the maximum number of users who can redeem, as well as a landing page/invitation URL for users to follow.

VX

next_billing_date

Next billing date

date

Nearest date when the user should be charged to have further access. Is set or changed: on renewal, when the grace period is applied, when a user subscription is prolonged on redemption, etc.

VX

next_renewal_flag

Next renewal flag

boolean

Shows that during the next renewal the subscription will jump to the next access period of a dynamic term. Not sending for payment terms

VX

next_verification_date

Next verification date

date

Nearest date when the user should be verified to have further access. Is in use for externally verified subscriptions. Is set or changed: on renew, when the grace period is applied, when user subscription is prolonged on redemption, etc.

VX

payment_authentication_required

Payment - Authentication required

boolean

To know if 3DS or any other authentication is required on payment event.

VX

payment_decline_reason

Payment - Decline reason

string

Payment failure decline reason groups the error codes into meaningful categories that the client can take action on. Categories can be for example "Suspected fraud", "Insufficient funds", etc.

VX

payment_error

Payment - Error

string

Error code is an ID of payment failure from the payment provider.

VX

payment_error_description

Payment - Error description

string

Error description of payment failure from the payment provider.

VX

payment_lost_amount_taxfree

Payment - Lost amount (excl. tax)

decimal

Value of failed payment (excluding taxes).

VX

payment_lost_amount_taxincluded

Payment - Lost amount (incl. tax)

decimal

Value of failed payment (including taxes).

VX

payment_provider

Payment provider

string

Third-party integration that assists in accepting a wide range of payment methods and allows the transfer of a transaction from point A to point B safely and securely (Braintree Apple Pay, OBI Credit Card, etc.).

VX

payment_rank

Payment - Rank

integer

Order number of payment charge period since the beginning of subscription. If the initial payment was 0 value trial then it’s excluded from the charge count.

VX

payment_retry_attempt

Payment - Retry attempt

integer

Number between 0 to X defining the payment retry attempt.

VX

pre_refund_transaction_amount

Pre-refund transaction amount

decimal

Original amount paid by the end-user before the refund action. Tax is included.

VX

renewal_period_count

Renewal period count

integer

Ordinal number of renewals from one access period to another

VX

resource_id

Resource ID

string

Identifier of the resource. The resource is used to control access to content the client is gating. A visitor gains access to a resource by subscribing, registering, entering a promo code, etc.

VX

resource_name

Resource name

string

Name of the resource. The resource is used to control access to content the client is gating. A visitor gains access to a resource by subscribing, registering, entering a promo code, etc.

VX

subscription_action

Subscription action

string

Action that specifies how the behavior of the subscription is changing (Auto-renew enabled, Canceled, Renewed, etc.).

VX

subscription_id

Subscription ID

string

Identifier of the subscription. Subscription is an entity created upon conversion on the term type (Payment, External, Gift, etc.). It is an agreement to receive/give something for a specific period of time.

VX

subscription_period_number

Subscription period number

integer

Is set to 1 on the subscription creation and is increased by 1 when a subscription is renewed (extended). Is decreased by 1 when access is revoked.

VX

term_billing_configuration

Term billing configuration

string

Describes a billing configuration of a term (Subscription / Fixed time period). Applicable for payment terms.

VX

trial_duration

Trial duration

string

Information on the duration of the trial period of a subscription (1 week, 1 month, etc.).

VX

upgrade_to_subscription_id

Upgrade to subscription ID

string

Identifier of the subscription after the upgrade.

VX

upgrade_to_term_id

Upgrade to term ID

string

Identifier of the term after the upgrade.

VX

vx_promo_code

Promo code

string

Promo code value

VX

vx_promotion_amount

Promotion amount

string

Monetary promotion amount in VX

VX

vx_promotion_id

Promotion ID

string

ID of promotion created in VX

VX

vx_promotion_name

Promotion

string

Promotion name created in VX

VX

vx_promotion_percentage

Promotion percentage discount

string

Percentage promotion discount in VX

Active churn prevention exposures

Composer

Number of templates or offers exposed to subscribers on the active churn attempt.

Active churn prevention exposed users

Composer

Number of unique users exposed to templates or offers on the active churn attempt.

Average exposure (page)

Composer

Average number of experience exposure events per page views (with exposure). Calculation: Experience exposures / Page views with exposure.

Average exposure (visitor)

Composer

Average number of experience exposure events per experience exposed visitors. Calculation: Experience exposures / Experience exposed visitors.

Experience action visitors

Composer

Total number of visitors with at least one experience action (execution & exposure). Calculation: All distinct visitors having experience.action event.

Experience actions

Composer

Total number of experience action events (execution & exposure). Calculation: Count the number of experience.action events.

Experience actions / visitor

Composer

Average number of experience.action events (executions & exposures) per experience targeted visitor. Calculation: Experience actions / Experience action visitors.

Experience adblock disabled visitors

Composer

Total number of visitors with at least one experience Adblock disablement for all terms. Calculation: All distinct visitors have composer.conversion event with Goal type "Adblock disabled" and Experience ID assigned.

Experience completion rate (visitor)

Composer

Overall experience completion rate calculated on visitor level. Calculation: Experience converted visitors / Experience interaction visitors.

Experience conversion rate (visitor)

Composer

Overall experience conversion rate (for all terms) calculated on visitor level. Calculation: Experience converted visitors / Experience exposed visitors.

Experience conversions

Composer

Total number of experience conversion events for all terms. Calculation: Count the number of vx.conversion and composer.conversion events with Experience ID assigned.

Experience converted visitors

Composer

Number of visitors with at least one experience conversion for all terms. Calculation: All distinct visitors having composer.conversion or vx.conversion event with Experience ID assigned.

Experience CTR

Composer

Average number of experience interaction events (template & offer clicks except "close button" clicks) and experience exposure events. Calculation: Experience interactions / Experience Exposures.

Experience CTR (visitor)

Composer

Overall click-through rate calculated on visitor level. Calculation: Experience interaction visitors / Experience exposed visitors.

Experience custom converted visitors

Composer

Total number of visitors with at least one experience custom conversion for all terms. Calculation: All distinct visitors having or vx.conversion event with Goal type "Custom term converted" and Experience ID assigned.

Experience exposed visitors

Composer

Total number of visitors with at least one experience exposure. Calculation: All distinct visitors have experience.action event with property "Is experience exposed?" set to TRUE.

Experience exposures

Composer

Total number of experience exposure events. Calculation: Count the number of experience.action events with property "Is experience exposed?" set to TRUE.

Experience interaction visitors

Composer

Total number of visitors with at least one experience interaction (template & offer click except for "close button" click). Calculation: All distinct visitors have experience.interaction event.

Experience interactions

Composer

Total number of experience interaction events (template & offer clicks except "close button" clicks). Calculation: Count the number of experience.interaction events.

Experience payment converted visitors

Composer

Total number of visitors with at least one experience payment conversion for all terms. Calculation: All distinct visitors having vx.conversion event with Goal type "Payment term converted" and Experience ID assigned.

Experience registration converted visitors

Composer

Total number of visitors with at least one experience registration conversion for all terms. Calculation: All distinct visitors having vx.conversion event with Goal type "Registration term converted" and Experience ID assigned.

Experience turnover

Composer

Sum of all amounts associated with experience conversion event paid by visitors. Calculation: Sum of all values for the property "Amount (incl. tax)" for composer.conversion and vx.conversion event with Experience ID assigned.

Experience turnover / visitor

Composer

Average amount associated with experience conversion event paid by the visitor. Calculation: Experience turnover / Experience converted visitors.

Form exposures

Composer/Identity

Number of times the form was exposed.

Form submissions

Composer/Identity

Number of times the form was submitted.

Form submission rate

Composer/Identity

Form submission rate is to evaluate the success of filled forms.

Subscribers active churn

Composer/Identity

Number of subscribers (users) who turned off autorenewals on subscriptions or immediate subscription cancellations.

Subscribers active churn rate

Composer/Identity

Ratio of disabled autorenewals or churns out of all subscribers attempting to churn.

Subscribers prevented active churn

Composer/Identity

Ratio of disabled autorenewals or churns out of all subscribers attempting to churn.

Subscribers prevented active churn rate

Composer/Identity

Ratio of subscribers who had intention to cancel subscription or turn off autorenewal but abandoned the churn flow and continued to be subscribers.

ID - Accounts deleted

Identity

Number of deleted accounts with Piano Identity due to Privacy compliance requests.

ID - Double opt-in confirmed accounts

Identity

Number of email addresses successfully confirmed after having previously registered with "Unconfirmed" status using the double opt-in feature. Calculation: Amount of identity.create events where the property "Identity - Double opt-in" equals "Confirmed by customer".

ID - Double opt-in submitted accounts

Identity

Number of email addresses submitted during registration with "Unconfirmed" status using the double opt-in feature. Calculation: Amount of identity.email.submit events where the property "Identity - Double opt-in" equals "Unconfirmed".

ID - Double opt-in success rate

Identity

Ratio of successfully confirmed email addresses registered with the double opt-in feature. Calculation: ID - Double opt-in confirmed accounts / ID - Double opt-in submitted accounts.

ID - Login events

Identity

Number of user login actions on the site. These login actions are managed by Piano Identity.

ID - Login frequency

Identity

Average number of login events per user logging in on the site.

ID - New accounts

Identity

Number of new accounts created with Piano Identity.

ID - Reset password requests

Identity

Number of requests to reset password through an email link. This action is managed by Piano Identity.

ID - Reset password success rate

Identity

Ratio between password reset success and password reset request.

ID - Reset password successes

Identity

Number of password resets that were successful. This action is managed by Piano Identity.

ID - Session expirations

Identity

Number of forced user logout actions due to session expiration. These expirations are managed by Piano Identity.

ID - Users already logged in

Identity

Identified users who didn't use the login page during the time period analyzed.

ID - Users already logged in rate

Identity

Ratio of users already connected to all users.

ID - Users logging in

Identity

Number of unique users logging into the site. These login actions are managed by Piano Identity.

Canceled subscriptions

VX

Number of subscriptions that were lost due to cancellation by the owner or admin. The associated access was revoked immediately. Calculation: Distinct subscription IDs for subscription.action event with property "Subscription action" = "Canceled".

Complete subscription upgrades

VX

Number of successfully completed subscription upgrades. Calculation: Distinct subscription IDs for subscription.action event with property "Subscription action" = "Upgrade completed".

Expired subscriptions

VX

Number of subscriptions that were lost because the auto-renew had been disabled prior to the renewal billing attempt. Calculation: Distinct subscription IDs for subscription.action event with property "Subscription action" = "Expired".

Failed subscription renewals

VX

Number of subscriptions that were lost due to a failed renewal attempt. Calculation: Distinct subscription IDs for subscription.action event with property "Subscription action" = "Renewal failed, will not retry".

Failed subscription upgrades

VX

Number of subscriptions that were lost due to a failed subscription upgrade. Calculation: Distinct subscription IDs for subscription.action event with property "Subscription action" = "Upgrade failed".

Lost subscriptions

VX

Number of lost subscriptions. Calculation: Distinct subscription IDs for subscription.action event with property "Subscription action" = "Canceled"/"Expired"/"Renewal failed, will not retry"/"Upgrade failed".

Net new subscriptions

VX

Difference between new and lost subscriptions. Calculation: New subscriptions - Lost subscriptions.

New subscriptions

VX

Number of new subscriptions. Calculation: Distinct subscription IDs for vx.conversion event with property "Created via upgrade?" = FALSE.

New VX turnover

VX

Amount of money obtained from successful monetary transactions associated with a conversion. Calculation: Sum of all values for the property "Amount (incl. tax)" for vx.conversion event.

Refunds

VX

Number of refunded monetary transactions. Calculation: Count the number of transaction.refund.offsite events.

Refunded VX turnover

VX

Amount of money refunded on previously successful monetary transactions. Calculation: Sum of all values for the property "Amount (incl. tax)" for transaction.refund.offsite event.

Refund VX ratio

VX

Average percentage of a refund. Calculation: Sum of all values for the property "Amount (incl. tax)" for transaction.refund.offsite event / Sum of all values for the property "Pre-refund transaction amount" for transaction.refund.offsite event.

Renewal VX turnover

VX

Amount of money obtained from successful monetary transactions associated with renewal. Calculation: Sum of all values for the property "Amount (incl. tax)" for subscription.action event with "Subscription action" = "Renewed".

Renewed subscriptions

VX

Number of subscriptions renewed into their next billing period. Calculation: Distinct subscription IDs for subscription.action event with property "Subscription action" = "Renewed".

Successful transactions

VX

Number of successful monetary transactions. Calculation: Distinct "Transaction ID" assigned to the events vx.conversion and subscription.action.

VX turnover

VX

Amount of money obtained from successful monetary transactions. Calculation: Sum of all values for the property "Amount (incl. tax)" for the events vx.conversion and subscription.action.

Bounce rate

ATI standard

Ratio between bounces and all visits.

Bounces

ATI standard

Number of visits with less than 2 pages (0 or 1, regardless of the number of events).

Conversion rate

ATI standard

Ratio between the number of visits converted to the main goal and the total number of visits.

Conversion rate (user)

ATI standard

Ratio between the number of users who converted to the main goal and the total number of users. Calculation: converted users / users.

Conversion rate (visitor)

ATI standard

Ratio between the number of visitors who converted to main goals and the total number of visitors. Calculation: Converted visitors / Visitors.

Converted users

ATI standard

Number of users who have converted to the main goals.

Converted visitors

ATI standard

Number of visitors who converted to the main objective.

Converted visits

ATI standard

Number of visits that have loaded the main goal page at least once.

Conversions

ATI standard

Number of events where goal type is defined.

Conversions (pages)

ATI standard

Number of page loads for pages defined as the main goal.

Days

ATI standard

Number of days with traffic.

Entering visits

ATI standard

Number of visits with at least 2 page loads.

Entry rate

ATI standard

Ratio between entering visits (with 2 page views and more) and all page visits. Calculation: Entering visits / Visits.

Events

ATI standard

Number of times an event occurred.

Events (all)

ATI standard

Number of events counted, including excluded events.

Page views

ATI standard

Number of times a page has been loaded. If the analyzed element was not present on a page, the value of this metric will necessarily be 0.

Page views / visit

ATI standard

Average number of page loads that occur during a visit. Calculation: page views / visits.

Time spent

ATI standard

Total time spent on site. This metric is expressed in milliseconds.

Time spent (pages)

ATI standard

Cumulative time spent on pages. Calculation: Sum of inter-pages durations. Excludes bounced visit pages and last visit pages. This metric is expressed in seconds.

Time spent (page) / page

ATI standard

Time spent on the same page on average per page. Calculation: Cumulation of the durations of a page P / Loads of this page P (with duration).

Time spent / event

ATI standard

Average time spent between events. Calculation: Time spent / number of events with duration.

Time spent / user

ATI standard

Average time spent on the site by users (visitors who have been identified).

Time spent / user (pages)

ATI standard

Average time spent on the site by visitors (those who have made at least 2 page loads within a visit).

Time spent / visit

ATI standard

Average duration of visits to the site. Calculation: cumulative time spent / visits with duration. This metric is expressed in milliseconds.

Time spent / visit (pages)

ATI standard

Average duration of visits to the site. Calculation: cumulative time spent / visits with duration. Visits without duration are excluded.

Time spent / visitor

ATI standard

Average time spent on the site by visitors (those who have made at least 1 visit).

Time spent / visitor (pages)

ATI standard

Average time spent on the site by visitors (those who have made at least 2 page loads within a visit).

Visitors

ATI standard

Number of visitors (each visitor recognized mainly with a cookie and who has made at least 1 visit). These visitors are distinct in the period.

Users

ATI standard

Number of users (identified visitors). These users are quite distinct over the period.

Visits

ATI standard

A visit is defined as a set of events that occurred on your site ("onsite" event) by the same visitor. If no event is measured during a defined period of time (usually 30 minutes), the visit ends.

Visits / user

ATI standard

Average number of visits per user (identified visitors).

Visits / visitor

ATI standard

Average number of visits per visitor.

Measurement label

Measurement key

Format

Description

Properties

Time aggregation

Property aggregation

Active subscriptions

m_active_subscriptions

Integer

Number of active subscriptions at the end of the day or analyzed period. In VX the following term types creates subscription: Payment, Dynamic, External, Linked, Site Licensing, Gift

• Term ID

• Term Name

• Term Type

• Resource ID

• Resource Name

Last Value

Sum

Active subscriptions with auto-renewal off

m_active_subscriptions_autorenewal_off

Integer

Number of payment term active subscriptions which have autorenewal turned off and dynamic term subscriptions which have deferred cancellation and upon the next renewal the subscription will expire. This metric can be used in the context of active churn that could be prevented

• Term ID

• Term Name

• Term Type

• Resource ID

• Resource Name

Last Value

Sum

Active subscriptions in grace period

m_active_subscriptions_in_grace_period

Integer

Number of active subscriptions that had renewal failure, are in the grace period and system will try to renew them. This metric can be used in the context of passive churn.

• Term ID

• Term Name

• Term Type

• Resource ID

• Resource Name

Last Value

Sum

Active subscriptions in trial

m_active_subscriptions_in_trial

Integer

Number of active payment term type subscriptions which are currently in the trial period. Notion of trial is not supported for any term type besides "Payment" term

• Term ID

• Term Name

• Term Type

• Resource ID

• Resource Name

Last Value

Sum

Measurement label

Measurement key

Format

Description

Properties

Time aggregation

Property aggregation

Active subscribers

m_active_subscribers

Integer

Number of users that have active subscription to any term. All types of subscriptions within VX are included. In VX the following term types creates subscription: Payment, Dynamic, External, Linked, Site Licensing, Gift. If user has multiple active subscriptions, the user is counted as 1 subscriber

None

Last Value

Sum

Users with active access

m_users_with_active_access

Integer

Number of users that have active access to any resource. All types of access activation within VX are included.

None

Last Value

Sum

All VX users

m_all_vx_users

Integer

Total number of users that are managed in VX or ID, including those that are not yet confirmed by the “Double Opt-in” functionality (if it’s used)

None

Last Value

Sum

Measurement label

Measurement key

Format

Description

Properties

Time aggregation

Property aggregation

Total site license seats

m_site_licence_seats

Integer

Maximum number of available seats per site license. If the max does not exist it is empty.

• Licencee ID

• Licensee Name

• Term ID

• Term Name

• Term type

• Resource ID

• Resource Name

Last Value

Sum

Active site licence users

m_site_licence_active_users

Integer

Number of users with status “Active”. Active user means that the user has redeemed site licensing access.

• Licencee ID

• Licensee Name

• Term ID

• Term Name

• Term type

• Resource ID

• Resource Name

Last Value

Sum

Pending site license users

m_site_licence_pending_users

Integer

Number of users with status “Pending”. Pending status represents the user who has been invited but has not yet redeemed access.

• Licencee ID

• Licensee Name

• Term ID

• Term Name

• Term type

• Resource ID

• Resource Name

Last Value

Sum

Revoked site license users

m_site_licence_revoked_users

Integer

Number of users whose access was revoked by the member of client team.

• Licencee ID

• Licensee Name

• Term ID

• Term Name

• Term type

• Resource ID

• Resource Name

Last Value

Sum

Invalid email site license users

m_site_licence_invalid_email_users

Integer

For email based site licensing contract - The user has an incorrect email.

• Licencee ID

• Licensee Name

• Term ID

• Term Name

Term type

• Resource ID

• Resource Name

Last Value

Sum