Campaign Recipients table¶

The Campaign Recipients table contains a list of Amperity IDs associated with any campaign that was sent from Amperity. Each campaign is associated with the segment used to generate the list of recipients, the control and treatment groups (including sub-audiences) used for the campaign, its launch date, and all destinations to which the campaign was sent.

The Campaign Recipients table is generated by Amperity, and then made available as a standard database table. Use this table to access campaign attributes, perform historical campaign analysis, and to build segments and multi-stage campaigns that use the results of previous campaigns.

Important

Data in the Campaign Recipients table is updated after the next database run. If your database is configured to run once per day then data in the Campaign Recipients table will be available on a 1-day delayed rolling basis.

Requirements¶

This topic assumes that at least one campaign has been configured, and then sent from Amperity.

Add table¶

The Campaign Recipients table can be enabled directly from the Campaigns page. It may be enabled for each database that is configured in your tenant.

To enable the Campaign Recipients table

Click the Campaign settings link next to the Create campaign button, and then open the Advanced tab.
Under Campaign Recipients, select the databases for which the Campaign Recipients table should be enabled.
Click Save.

Campaign delivery dates¶

The following query returns campaigns sorted by earliest and latest delivery dates by campaign ID or campaign name.

SELECT
  campaign_id
  ,campaign_name
  ,sub_audience_name
  ,treatment_name
  ,treatment_id
  ,delivery_datetime
  ,MIN(delivery_datetime) AS earliest_delivery_date
  ,MAX(delivery_datetime) AS latest_delivery_date
FROM Campaign_Recipients
WHERE campaign_id IN ('campaign-id')
OR campaign_name IN ('campaign-name')
GROUP BY 1,2,3,4,5,6
ORDER BY 5,6,7

where the WHERE statement is updated for the specific campaign ID and/or campaign name.

Column reference¶

The Campaign Recipients table contains the following columns:

Column name	Data type	Description
Amperity ID	String	The unique identifier that is assigned to clusters of customer records that all represent the same individual. The Amperity ID does not replace primary and foreign keys, but exists alongside them within unified profiles. Note The Amperity ID is a universally unique identifier (UUID) that is represented by 36 characters spread across five groups separated by hyphens: 8-4-4-4-12. For example: 123e4567-e89b-12d3-a456-426614174000
Campaign ID	String	The unique ID for a campaign.
Campaign Name	String	The name of the campaign.
Campaign Type	String	A campaign is a message or offer that is sent to a specific group of customers or recipients. A campaign may be one of the following types: One-time Recurring A one-time campaign represents a specific campaign message that is configured to be sent only once. A recurring campaign is sent automatically based on an updated/refreshed audience that a customer wants to receive in their outbound destination or a state change, such as an accepted return, a change to a loyalty program, or an alert based on credit card status, with a predefined campaign message and cadence to a list of recipients.
Database ID	String	The unique ID for the database.
Database Name	String	The name of the database.
Dataset Version	String	A unique ID for the dataset used with this set of campaign recipients.
Delivery Datetime	Datetime	The date and time at which the associated campaign ID was delivered to the destination.
Destination ID	String	The unique ID for a destination.
Destination Name	String	The name of the destination to which the associated campaign ID was sent.
Is Control	Boolean	A flag that indicates if the Treatment ID represents a control group.
Launch Datetime	Datetime	The date and time at which the associated campaign ID was sent from Amperity to its downstream workflow.
PK	String	The combination of data source and primary key allows Amperity to uniquely identify every row in every data table across the entirety of customer data input to Amperity.
Segment ID	String	The unique ID for the segment that generated the list of recipients for the associated campaign ID.
Segment Name	String	The name of the segment used with the associated campaign ID.
Sub Audience ID	String	The unique ID for the sub-audience to which the associated campaign was sent.
Sub Audience Name	String	The name of the sub-audience to which the associated campaign was sent.
Target ID	String	The unique ID for the data template that was used to send campaign data to a downstream channel or workflow.
Target Name	String	The name of the data template that was used to send campaign data to a downstream channel or workflow.
Treatment ID	String	The ID for the treatment group to which the associated campaign was sent.
Treatment Name	String	The name of the treatment group to which the associated campaign was sent. One or more treatment groups, along with a control group, are used to measure the quality of a campaign.
Workflow ID	String	The unique ID for the workflow that managed the associated campaign.