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 |
|---|---|---|---|
Access Count |
Access Count |
Total number of visits made by a user over their entire existence. |
metric |
Address 1 |
Address 1 |
The first line of the user’s billing or contact address. |
dimension |
Address 2 |
Address 2 |
The second line of the user’s billing or contact address, if applicable. |
dimension |
Address city |
Address city |
The city component of the user’s billing or contact address. |
dimension |
Address country |
Address country |
The country component of the user’s billing or contact address. |
dimension |
Address state |
Address state |
The state or province component of the user’s billing or contact address. |
dimension |
Auto Renew Enabled |
Auto Renew Enabled |
Indicates whether a subscription is set to automatically renew at the end of its term. |
dimension |
Billing Zip Code |
Billing Zip Code |
The postal code associated with the user’s billing address. |
metric |
Cancellation Date |
Cancellation Date |
The date when a subscription was canceled. |
dimension |
Charge Count |
Charge Count |
The total number of charges made against a subscription or user account. |
metric |
City |
City |
The city component of a user’s registered or primary address. |
dimension |
Company Name |
Company Name |
The name of the publisher’s application or organization associated with the data. |
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. |
dimension |
Conversions |
Conversions |
The total number of times a user completed a specific desired action (e.g., purchase, registration), as reported in the Conversions Report. |
dimension |
Country |
Country |
The country component of a user’s registered or primary 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 |
The primary email address of the user. |
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 user. |
dimension |
Has Trial? |
Has Trial? |
Boolean indicator showing whether a subscription included a trial period. |
dimension |
ID |
ID |
A unique identifier for a record or entity, such as an application, user, subscription, or conversion event. |
dimension |
Last Billing Date |
Last Billing Date |
The date of the most recent successful billing for a subscription. |
dimension |
Last Name |
Last Name |
The last name or surname of the user. |
dimension |
Money Spent |
Money Spent |
The total monetary amount spent by a user on subscriptions or other purchases. |
dimension |
Name |
Name |
The name associated with an entity, such as an application, product, offer, or user. |
dimension |
Name (first and last) |
Name (first and last) |
The combined first and last names of the user. |
dimension |
Next Billing Date |
Next Billing Date |
The date when the next billing cycle for a subscription is scheduled. |
dimension |
Offer Template ID |
Offer Template ID |
Unique identifier for the offer template used in a subscription or conversion event. |
dimension |
Offer Template Name |
Offer Template Name |
The name of the offer template presented to the user. |
dimension |
Phone |
Phone |
The contact phone number of the user. |
dimension |
Postal code |
Postal code |
The postal code component of a user’s registered or primary address. |
dimension |
Price |
Price |
The monetary price of a product, offer, or subscription. |
dimension |
Promo Code |
Promo Code |
The promotional code applied to a subscription or purchase. |
dimension |
Renewed |
Renewed |
Indicates whether a subscription has been successfully renewed. |
dimension |
Resource ID (RID) |
Resource ID (RID) |
Unique identifier for a specific digital resource or content item to which access is granted. |
dimension |
Resource Name |
Resource Name |
The human-readable name of the digital resource or content item. |
dimension |
Start Date |
Start Date |
The activation date of a subscription or the beginning of a specific period. |
dimension |
State |
State |
The state or province component of a user’s registered or primary address. |
dimension |
Status |
Status |
The current status of a subscription (e.g., active, canceled, expired) or user account. |
dimension |
Subscription Grace Period Start Date |
Subscription Grace Period Start Date |
The date when a subscription enters a grace period after a payment failure. |
dimension |
Subscription Trial End Date |
Subscription Trial End Date |
The date when a subscription’s trial period concludes. |
dimension |
Tax |
Tax |
The amount of tax applied to a transaction or subscription. |
dimension |
Tax base |
Tax base |
The subtotal amount used to calculate tax before tax is applied. |
dimension |
Tax country |
Tax country |
The country jurisdiction used for tax calculation. |
dimension |
Tax rate |
Tax rate |
The percentage rate of tax applied to a transaction. |
metric |
Tax state/province |
Tax state/province |
The state or province jurisdiction used for tax calculation. |
dimension |
Term ID |
Term ID |
Unique identifier for the specific term (e.g., monthly, annual) of a subscription. |
dimension |
Term Name |
Term Name |
The human-readable name of the subscription term (e.g., ‘1 Month’, ‘Annual’). |
dimension |
Total $ Charged |
Total $ Charged |
The total monetary value successfully charged to a user for subscriptions or purchases. |
metric |
Total $ Refunded |
Total $ Refunded |
The total monetary value refunded to a user for canceled subscriptions or purchases. |
metric |
URL |
URL |
The web address associated with the event, such as the page where a conversion or user interaction took place. |
dimension |
User |
User |
Represents an individual user being tracked by the platform, identified by a unique ID, for whom subscription, entitlement, and behavioral data is collected. |
dimension |
User Access Expiration Date |
User Access Expiration Date |
The date when a user’s entitlement or access to a resource will expire. |
dimension |
User ID |
User ID |
A unique identifier for a user within the Piano platform, crucial for linking data across reports like the Users Report. |
dimension |
User ID (UID) |
User ID (UID) |
A unique identifier for a user within the Piano platform, often explicitly referred to as UID in documentation. |
dimension |
device |
Device |
The device used by the user when interacting with the digital property, which can include information like device type, brand, and operating system, often derived through native data enrichment. |
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 |