Campaign_Recipients Table

The Campaign_Recipients table contains a list of Amperity IDs associated with any campaign (i.e., sub-audiences) that were sent from Amperity. Each campaign is associated with the segment used to generate the list of recipients, the control and recipient 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 leverage 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

Ask your Amperity representative to add the Campaign_Recipients table and enable it for your tenant.

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 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.

treatment_id

String

The ID for the recipient group to which the associated campaign was sent.

treatment_name

String

The name of the recipient group to which the associated campaign was sent. One or more recipient 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.