Data Dictionary

Data Dictionary

To help our clients better understand the performance of their campaigns and the behavior of their customers, Koupon Media collects data about every interaction and event that occurs on its platform.

Below we’ve defined all of the data points that are available for our clients. It’s important to remember that not all of these data points are available for every customer or every event. The availability of some data requires custom implementations, while other data points are only available for certain types of offers, channels or delivery methods.

To learn more about how this data can help grow your business, get in touch with our data team.

Core Data

Data Point Description
consumer_offer_transaction_date The date & time of the transaction event (in UTC).
client_id Numeric identifier of the client that owns the offer and customer.
client_name The name of the client identified in the Client ID.
promo_id Numeric identifier of the Offer.
consumer_offer_transaction_state The state for the record, commonly including offer interactions and messages.
consumer_offer_transaction_barcode The barcode string(s) associated with the offer instance for the customer.
consumer_offer_transaction_source The type of source used to view the offer — includes mobile web, app and desktop.
consumer_offer_transaction_short_url The generated short URL for an offer.
consumer_offer_transaction_long_url The source and longer version of the URL used to generate the short URL.
consumer_offer_transaction_venue The name of the store at which the offer was redeemed by the customer.
store_id The Id of the store at which the offer was redeemed by the Consumer.
consumer_offer_transaction_ipaddress The IP address reported by the Consumer device with the transaction event.

Offer Data

Data Point Description
promo_name The internal name of the offer, not shown to the customer.
promo_title Also known as the offer’s Headline.
promo_desc Also known as the offer’s Sub Headline.
promo_start_date The start date & time of the offer.
promo_end_date The end date & time of the offer.
tag_values Also known as “Categories”, these are shown in relation to the offer aspect of the transaction event.
offer_type The type of offer (e.g., BOGO, Free, $ Off, etc.) as configured in Koupon Manager.
offertype_value The market value of the offer (e.g., $1, $2.50, etc.) as configured in Koupon Manager.
offer_style The style of the offer, such as Receipt Capture, Native Ad, Regular, etc.
consumer_offer_transaction_dp_multi_use Identifying whether the offer is Limited Use or Unlimited Use.
consumer_offer_transaction_dtb_type The distribution type of the offer (e.g., SMS, Facebook, Website, etc.).
consumer_offer_transaction_sms_distribution_message The content of the SMS or push notification that was sent to a customer.
offer_visibility Identifying whether the offer is public (available to everyone) or for private targeting use cases.
offer_start_delay If created as private, the offer’s delay start time based on the target event.
offer_redemp_period If created as private, the offer’s Duration start time based on the target event.
redir_channel_code If the Offer is a Native Ad that leads to an internal channel link, this is the Channel ID provided.

Channel Data

Data Point Description
channel_name The name of the Channel being used to view the offer.
channel_description A description of the channel as added in Koupon Manager
channel_style The style of Channel such as Offer Viewer, Scratcher or others.
app_session_time Time since the preceding App Open event, in seconds.

Customer State

Data Point Description
NewUser A new consumer engaged with an offer.
Access An offer was viewed by a consumer.
Presented An Offer was activated for redemption, through barcode display, add to card, or submitted rebate.
EmailSent An Offer was delivered to a consumer via e-mail distribution by Koupon.
ShortLinkCreated An SMS short URL was created by Koupon to deliver an offer to a consumer.
Delivered An Offer was delivered to a consumer via SMS distribution.
Viewed An Offer was opened by a consumer on a mobile device.
Done Redemption of an offer was completed, or the redemption timer for the offer expired.
POSRedeem A POS system reported that an offer was redeemed using a redemption asset (e.g. barcode).
POSVoid A POS system reported that an offer redemption was voided for a specific redemption asset.
AppOpen The customer's app entered the foreground by opening or restoring from standby.
AppClose The customer's application left the foreground by being closed or entering standby mode.
InfluencedOpen The Client's application entered the foreground, due to tapping on a related Push notification.
LocOptOut A consumer opted out of sharing location within an offer experience.
LocOptIn A consumer opted in to sharing location within an offer experience.
ConsumerQualified A targeted offer was added to a customer after they completed some type of action.
SmsOptIn A mobile consumer opted-in for future SMS text messages from a client.

Customer Data

Data Point Description
pii_primary Koupon owned unique identifier for a customer in a given account. Primary IDs most often have another form of identity from the fields listed below.
pii_anonymous Generated unique identifier for the Consumer with no other PII identity, generated when the consumer access the offer from mobile web browser. This identity is essentially a web cookie.
consumer_pii_mobile The registered mobile phone number of the Consumer.
consumer_pii_email The registered e-mail address of the Consumer.
consumer_pii_cid The registered CRM identifier of the Consumer, commonly passed to Koupon from a retailer or brand.
pii_udid Unique Device Identifier of the Consumer's device when the consumer views offers from a mobile app.
pii_vendorid Vendor identifier of the Consumer's device when the consumer views offers from a mobile app.
referring_consumer The (anonymous) consumer identity from a Desktop capture page that led to mobile activity.
state The state/province of the location of the Consumer at the time of the transaction event.
city The city of the location of the Consumer at the time of the transaction event.
zipcode The zipcode/postal code of the location of the Consumer at the time of the transaction event.
neighborhood The neighborhood of the location of the Consumer at the time of the transaction event.
dob The date of birth of the Consumer, in YYYY-MM-DD format.
income Income of the Consumer, in US Dollars.
affinity Information about the interests or preferences of the Consumer, as a comma-separated list.
gender A numeric value representing the gender of the Consumer —Unknown ( null / 0), Male (1), Female (2), Not Applicable (9).
education A numeric value representing the level of education of the Consumer: Unknown (Null or 0), Some High School (1), High School (2), Some College (3), Associates Degree (4), Undergraduate Degree (5), Graduate Degree (6), Post Graduate Degree (7).
loyalty_id The identifier of a Consumer's Loyalty Card the Offer was added to. Only applies to events with Loyalty Card Offer Style.
target_name The name of the Target List that was used for a targeted SMS, Push, or Add Offer message.
adult_class Adult Class of the customer — only applies to restricted offers.
adult_subclass Adult Subclass of the customer — only applies to restricted offers.
ua_device Device details of the customer.
consumer_offer_transaction_user_agent The user agent of the transaction event reported by the Consumer device.
ua_manufacturer Manufacturer of the customer’s device.
ua_os_family Family of OS portion of user-agent.
ua_os_full Full OS portion of user-agent.
ua_browser_full Full browser portion of user-agent.
ua_browser_family Family of browser portion of user-agent.
ua_browser_major Major version of browser portion of user-agent.

Location Data

Data Point Description
consumer_offer_transaction_latitude Latitude of the Consumer's location at the time of the transaction event.
consumer_offer_transaction_longitude Longitude of the Consumer's location at the time of the transaction event.
fence_id Numeric identifier of the Geofence that a Consumer device reported entering or leaving.
fence_name Name of the Geofence definition that a consumer device reported entering or leaving.
fence_dwell The number of seconds spent within a the defined fence.
dist_from_city The distance of the registered location from the closest city (identified in the “city” column).
prox_xmitter_id Identifier of a beacon that a consumer device is reported as being near.
prox_xmitter_name Name of a beacon that a consumer device is reported as being near.
prox_dwell_time Time since preceding beacon event.
prox_metadata Optional meta data included in beacon events.
prox_battery_level String indicating battery level (High, Med-High, Med-Low, Low) reported by Beacon.
prox_temperature Temperature in Fahrenheit reported by a beacon.

Other Services Data

Data Point Description
push_platform The platform of the consumer device registering for or receiving a push notification — either iOS or Android.
push_device_token The unique device identifier of a Consumer device app registering for or receiving a push notification.
managing_app Name of digital wallet application, corresponding to Apple Wallet or Google Wallet.
wallet_class The identifier of the type of Wallet object (i.e. Apple Wallet passTypeIdentifier or Google Wallet Offerclass.id).
wallet_instance The identifier of the instance of Wallet object (i.e. Apple Passbook serialNumber or Google Wallet Offerobject.id).
card_balance A string representing the updated balance on the card associated with the instance of a wallet object.