Piano ESP: Most-used fields

The table below gives information about most-used fields that you can import from Piano ESP. 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
Active	Active	Indicates whether a campaign or mailing list is currently operational or available for use.	metric
Campaign ID	Campaign ID	A unique identifier for a specific email campaign. This ID is used to retrieve details or associated mailing lists for that campaign.	metric
Date	Date	The relevant date associated with a campaign or mailing list, such as creation date, last modification date, or a scheduled start/send date.	dimension
Id	Id	A unique identifier for the campaign or mailing list within the Piano ESP system.	dimension
ScheduleType	ScheduleType	Defines the type of scheduling configured for a campaign, such as immediate delivery, one-time scheduled send, or a recurring schedule.	dimension
Stage	Stage	Represents the current phase or status of a campaign within its lifecycle (e.g., Draft, Pending, Sending, Completed, Archived).	metric
Type	Type	Categorizes the nature of a campaign (e.g., promotional, newsletter, acquisition, loyalty) or a mailing list (e.g., opt-in, suppression).	metric
mailingLists	mailingLists	A collection or reference to the mailing lists associated with a publisher or a specific campaign.	dimension