Piano: Most-used fields

Piano: Most-used fields#

The table below gives information about most-used fields that you can import from Piano. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name

Adverity UI name

Description

Use in Adverity

Address 1

Address 1

First line of the user’s address for billing or shipping purposes.

dimension

Address 2

Address 2

Second line of the user’s address for billing or shipping purposes.

dimension

Address city

Address city

City component of the user’s address for billing or shipping purposes.

dimension

Address country

Address country

Country component of the user’s address for billing or shipping purposes.

dimension

Address state

Address state

State or province component of the user’s address for billing or shipping purposes.

dimension

Auto Renew Enabled

Auto Renew Enabled

Indicates whether the subscription is set to automatically renew at the end of its term.

dimension

Billing Zip Code

Billing Zip Code

The zip code or postal code associated with the user’s billing address.

metric

Cancellation Date

Cancellation Date

The date when the subscription was cancelled.

dimension

Charge Count

Charge Count

The total number of charges successfully processed for a subscription.

metric

City

City

City associated with a user or an address, potentially for general user information rather than billing.

dimension

Company Name

Company Name

The name of the company associated with the user or subscription.

dimension

Conversion rate

Conversion rate

The percentage of users who completed a desired action, such as a subscription or registration, as tracked by the Conversions Report.

metric

Conversions

Conversions

The total number of times a user completed a specific desired action (e.g., purchase, registration), as reported in the Conversions Report.

metric

Country

Country

The country associated with a user, often derived from their location at the time of conversion or their billing address.

dimension

Currency

Currency

The currency used for transactions and pricing (e.g., USD, EUR).

dimension

Date

Date

The date associated with an event, such as a conversion, subscription, or user action.

dimension

Experience ID

Experience ID

Unique identifier for a user experience or campaign within Piano’s Composer, used in the Conversions Report (exp_id).

dimension

First Name

First Name

The first name of the subscriber or user.

dimension

ID

ID

A unique identifier for an entity, such as a subscription, offer, or user.

metric

Last Billing Date

Last Billing Date

The date of the most recent successful billing for the subscription.

dimension

Last Name

Last Name

The last name of the subscriber or user.

dimension

Name (first and last)

Name (first and last)

The full name of the subscriber or user, combining first and last names.

dimension

Next Billing Date

Next Billing Date

The next scheduled date on which the user is expected to be charged for their subscription.

dimension

Offer Template ID

Offer Template ID

A unique identifier for the offer template used for a subscription.

dimension

Offer Template Name

Offer Template Name

The name of the offer template used for a subscription.

dimension

Phone

Phone

The contact phone number of the user or subscriber.

dimension

Postal code

Postal code

The postal code component of the user’s address.

dimension

Price

Price

The monetary price of the subscription or offer.

dimension

Promo Code

Promo Code

Any promotional code applied to the subscription or offer.

dimension

Renewed

Renewed

Indicates whether the subscription has been renewed.

dimension

Resource ID (RID)

Resource ID (RID)

A unique identifier for a specific resource, such as a product or content item, that the subscription provides access to.

dimension

Resource Name

Resource Name

The name of the resource that the subscription provides access to.

dimension

Start Date

Start Date

The date when the subscription or term began.

dimension

State

State

State or province information, potentially for general user information.

dimension

Status

Status

The current status of the subscription (e.g., active, cancelled, expired).

dimension

Subscription Grace Period Start Date

Subscription Grace Period Start Date

The start date of a grace period for the subscription, allowing continued access after a payment issue.

dimension

Subscription Trial End Date

Subscription Trial End Date

The end date of a trial period for the subscription.

dimension

Tax

Tax

The total tax amount applied to the subscription or transaction.

dimension

Tax base

Tax base

The amount on which tax is calculated.

dimension

Tax country

Tax country

The country relevant for tax calculation.

dimension

Tax rate

Tax rate

The percentage rate at which tax is applied.

metric

Tax state/province

Tax state/province

The state or province relevant for tax calculation.

dimension

Term ID

Term ID

A unique identifier for the specific term of a subscription.

dimension

Term Name

Term Name

The name or description of the subscription term.

dimension

Total $ Charged

Total $ Charged

The cumulative monetary amount charged for the subscription.

metric

Total $ Refunded

Total $ Refunded

The cumulative monetary amount refunded for the subscription.

metric

URL

URL

A URL associated with an event, page, or resource within the Piano platform.

dimension

User

User

Represents the user associated with a subscription or activity.

dimension

User Access Expiration Date

User Access Expiration Date

The date when a user’s access entitlement expires.

dimension

User ID (UID)

User ID (UID)

A unique identifier for the user.

dimension

source

Source

The origin or referrer of the user’s first visit to the digital property, such as a search engine, social media platform, or direct access.

dimension