Piano

The table below gives information about all the data fields that you can import from Piano.

To see the fields you can collect from another data source, go back to the Available fields in Adverity overview.

Field UI name

Field API name

Data Type

Description

Use in Adverity

Docs

Access Count

access_count

long

Access Count.

metric

Canvas action

action

string

Conversion canvas action (template, offer etc.).

dimension

Address 1

address_1

string

For PSC or print address collection terms, the first line of the print subscription recipient's address.

dimension

Address 2

address_2

string

For PSC or print address collection terms, the second line of the print subscription recipient's address.

dimension

Address city

address_city

string

For PSC or print address collection terms, the city of residence of the print subscription recipient.

dimension

Address country

address_country

string

For PSC or print address collection terms, the country of residence of the print subscription recipient.

dimension

Address state

address_state

string

For PSC or print address collection terms, the state of residence of the print subscription recipient.

dimension

Auto Renew Enabled

auto_renew_enabled

boolean

A T/F field that indicates whether the user opted to have their subscription automatically renewed.

dimension

Billing Zip Code

billing_zip_code

string

The ZIP or postal code that this transaction was billed to.

dimension

Browser

browser

string

The browser with which the conversion was made.

dimension

Campaign Codes

campaign_codes

string

The campaign code (if applicable) that the user followed prior to converting on the term.

dimension

Cancellation Date

cancellation_date

datetime

The date and time that a subscription was canceled (if applicable).

dimension

Category

category

string

Conversion category (clicks, closes etc.).

dimension

Charge Count

charge_count

long

The number of times that the user has been charged for the given subscription.

metric

City

city

string

The city that the user was in upon converting on the term, collected using GeoIP.

dimension

Company Name

company_name

string

The name of the company that the user provided (if applicable) upon converting on the term.

dimension

Context

context

string

Context of canvas action.

dimension

Conversion Rate

conversion_rate

float

The conversion rate for offers shown within the variant's branch.

metric

Conversions

conversions

long

The number of exposures which successfully resulted in a VX or external conversion within the variant's branch.

metric

Country

country

string

The country that the user was in upon converting on the term, collected using GeoIP.

dimension

Currency

currency

string

Type of currency (i.e, USD, EUR, etc).

dimension

Date

date

date

Date.

dimension

Device

device

string

The type of device that the user was on when he or she converted on the subscription term. Most common options include desktop, tablet, mobile, but you might also see DMR (Digital media receivers, e.g. Roku), game consoles (e.g. PlayStation, Xbox), and other (e.g. wearables, smart TV's, etc.).

dimension

Email

email

string

The email of the user.

dimension

Experience ID

experience_id

string

ID of the Composer experience that triggered the offer template.

dimension

Exposures

exposures

long

The number of times the variant's branch has resulted in an offer being presented.

metric

First Name

first_name

string

The first name the user provided upon registering.

dimension

Has Trial?

has_trial

string

The Y/N answer if the user has trial period.

dimension

ID

id

string

The subscription ID assigned to the user after the subscription is confirmed.

dimension

Last Billing Date

last_billing_date

datetime

The date and time that the user was last billed for their subscription.

dimension

Last Comment

last_comment

string

The last comment of the user.

dimension

Last Name

last_name

string

he last name the user provided upon registering.

dimension

Location

location

string

Highest-converting location (top market, country).

dimension

Money Spent

money_spent

currency

Amount of money spent by user.

metric

Name (first and last)

name

string

For PSC or print address collection terms, the first and last name of the print subscription recipient.

dimension

Name

name

string

The first and the last name of the user.

dimension

Next Billing Date

next_billing_date

datetime

The date and time that the user will next be billed for the subscription.

dimension

Offer Template ID

offer_template_id

string

The unique template ID of the offer template that contained the term that the user converted on.

dimension

Offer Template Name

offer_template_name

string

The name of the offer template at the time the user converted on the term. This may be different from the current name if you edited the name between the time of conversion and the time of generating the report.

dimension

Operating system

operating_system

string

The operating system with which the conversion was made.

dimension

Phone

phone

string

For PSC or print address collection terms, the phone number of the print subscription recipient.

dimension

Postal code

postal_code

string

For PSC or print address collection terms, the postal code of the print subscription recipient.

dimension

Price

price

currency

The price listed for the term that the user converted on at the time of conversion, as defined by you. Note that this may be different from the current price if the price has been edited between conversion date and report access date.

metric

Promo Code

promo_code

string

The promo code that the user redeemed (if applicable) at the time of purchasing the subscription.

dimension

PSC subscriber number

psc_subscriber_number

string

The Print Subscription Confirmation subscriber number (if applicable) that uniquely identifies the user for a print subscription.

dimension

Renewed

renewed

string

A Y/N field that indicates whether the subscription has been renewed since its original purchase.

dimension

Resource ID (RID)

resource_id

string

The resource ID that was assigned to the resource or edited by you before any users converted on the resource.

dimension

Resource Name

resource_name

string

The resource that the user converted on, as named by you when you created the resource.

dimension

Shared accounts

shared_accounts

string

Shared accounts.

dimension

Since

since

datetime

The date and time since became user.

dimension

Source

source

string

Conversion source (interactions, external, ESP etc.).

dimension

Start Date

start_date

datetime

The date and time that the subscription access began. Note that this is not necessarily the same as the purchase date.

dimension

State

state

string

The state, province, or territory that the user was in upon converting on the term, collected using GeoIP.

dimension

Status

status

string

The status of subscription access. Can be active, canceled, expired, upgraded, won't renew or payment failure.

dimension

Subscription Grace Period Start Date

subscription_grace_period_start_date

datetime

The date and time that a user's grace period began due to the end of a trial or the expiration of a previous subscription.

dimension

Subscription Trial End Date

subscription_trial_end_date

datetime

The date and time that a user's subscription trial will end, and the user will be prompted to pay to maintain access.

dimension

Summary

summary

string

The nature of the subscription that the user converted on. This is generated by Piano based on your selections.

dimension

Tag

tag

string

Custom conversion tag.

dimension

Tax

tax

currency

The amount of tax charged on this transaction, in the currency the transaction was conducted in.

metric

Tax base

tax_base

currency

The base amount of the good associated with this transaction, upon which the tax amount was calculated.

metric

Tax country

tax_country

string

The country for which the tax was applied. Blank for transactions prior to August 2017, when collection for this field began.

dimension

Tax rate

tax_rate

float

The rate of tax associated with this transaction.

metric

Tax state/province

tax_state_province

string

The state or province for which the tax was applied, if required.

dimension

Template

template

string

Convertion template name.

dimension

Template variant

template_variant

string

Iterations of templates that inherit all of their HTML/CSS, and allow for changes via content fields.

dimension

Term ID

term_id

string

The term ID that was assigned to the term the user converted on upon creation of that term.

dimension

Term Name

term_name

string

The name of the term that the user converted on as it was at the time of conversion. This name was created and is editable by you.

dimension

Total $ Charged

total_charged

currency

The amount that the user has paid to date on the given subscription and renewals.

metric

Total $ Refunded

total_refunded

currency

The amount that has been refunded to the user with respect to the given subscription.

metric

Total $ TP Fees

total_tp_fees

currency

The amount that Piano collects due to any fees associated with the transaction.

metric

Total $ of TP Fees Refunded

total_tp_fees_refunded

currency

The amount that Piano has refunded to the publisher with respect to the given subscription.

metric

URL

url

string

The URL that the user was on when he or she converted on the subscription term.

dimension

User

user

string

The email address that the user provided upon registering. Note that registration may have happened before the user converted on the term.

dimension

User Access Expiration Date

user_access_expiration_date

datetime

The date and time that a user's access to the purchased subscription will end.

dimension

User ID (UID)

user_id

string

The unique ID pertaining to the user, assigned at creation of the user account.

dimension

User ID

user_id

string

Unique identifier of the user.

dimension

Value

value

float

Value.

metric