Introduction

This guide provides a high-level overview of how Coupon Accounts created within the AIR platform can be tracked throughout their lifecycle.

We allow coupons to be created with tracking codes or pieces of information that provide clients with the ability to gather more information about how the coupon was redeemed by the consumer. This is especially helpful with regard to running Campaigns as part of an Omnichannel Marketing Strategy.

How is this supported?

AIR supports this by utilizing UTM tracking. UTM stands for "Urchin Traffic Monitor". This name comes from Urchin Tracker, a web analytics software that served as the base for Google Analytics. These UTM codes can be appended to URLs used in digital advertising, and having these data points allow you to easily identify which specific ad, campaign, or channel is yielding the best results.

Attributes

There are 5 data points within the Metadata of an Account that enables this functionality. These are defined as follows:

Name	Key	Type	Description
UTM Source	utm_source	string	Identifies which site the visitors are coming from.
UTM Medium	utm_medium	string	Identifies which marketing channels are bringing the visitor to the site.
UTM Campaign	utm_campaign	string	Identifies which campaign the promotion is associated with.
UTM Term	utm_term	string	Identifies search terms.
UTM Content	utm_content	string	Identifies the exact element on the ad or promotion that was clicked.

Account Creation

An Account can then be created with these attributes set in the API request payload. The following shows an example of the structure required by the Wallet API.

Create Coupon

{
    "status": "ACTIVE",
    "state": "LOADED",
    "meta": {
        "utm_source": "google",
        "utm_medium": "email",
        "utm_campaign": "winter-sale-50%-off",
        "utm_term": "winter+sale+50%",
        "utm_content": "textlink"  
    }
}

How to view this information?

There are multiple ways to view these Account attributes split between the following

Dashboard

The UTM data can be viewed from within the Customer Care section of dashboard. This can be found by navigating to the 'Additional Information' section of a Coupon Account within a Wallet as shown in the screenshot below.

API's

The UTM data is also included in responses from API endpoints that return Coupon Accounts (where the data was provided on initial Account creation). An example payload response is shown below with full documentation of each endpoint included in the API reference section of this portal.

{
    "accountId": "96443343",
    "walletId": "13527270",
    "campaignId": "2389201",
    "type": "ECOUPON",
    "clientType": "STANDARD",
    "status": "ACTIVE",
    "state": "LOADED",
    "dates": {
        "start": "2023-08-29T10:43:13+00:00",
        "end": "2023-10-26T23:59:00+00:00"
    },
    "meta": {
        "utm_source": "google",
        "utm_medium": "email",
        "utm_campaign": "winter-sale-50%-off",
        "utm_term": "winter+sale+50%",
        "utm_content": "textlink"
    },
    "dateCreated": "2023-08-29T10:43:13+00:00",
    "lastUpdated": "2023-08-29T10:43:13+00:00",
    "overrides": [],
    "balances": {
        "available": 0,
        "refundable": 0
    },
    "relationships": [],
    "mobileWallet": "https://mobilewallet.digital/add/account/96443343/3319f24b33254d90e848eeae70dc32fc758e87b4a581ea4e823e73259d071c64"
}