Displaying customer profiles
A customer profile contains data created and updated by the Campaign Manager as well as external data shared through the Integration API, such as the email address, postal address or full name of the customer.
You can learn more about customer profiles in our Developer docs.
In a customer profile, you can find information about:
- The amount of money spent by your customer in any campaigns within an Application.
- The total amount of discount obtained by your customer.
- Custom attributes with values defined for your customer profile.
- All your customer's sessions.
- Loyalty programs your customer is taking part in.
- Loyalty cards your customer has registered.
- Your customer's referral codes.
- The status of profile budgets for your customer.
- Achievements your customer is participating in.
- All coupons that have your customer as the recipient integration ID.
Some of this data can be useful for troubleshooting. For example, your customer support agents can verify each customer's details and provide them with information on which of their referral codes have been redeemed, or adjust the number of loyalty points in the customer's wallet if necessary.
Customer profile environments
Customer profiles are either part of a sandbox or a live environment. This helps differentiate between test data and production data.
The environment of a customer profile is automatically set to match the Application related to the profile. Customer profiles are only created and updated via the Integration API. So, if you send a request that relies on an Integration API key related to a sandbox Application, the customer profile will be a sandbox profile. A sandbox profile and a live profile can have the same Integration ID as they are treated as entirely separate profiles by our system.
Customer data is still shared between Applications from the same environment.
Listing customer profiles
To display all the customer profiles of the Application, on the left-side menu, click Customers. The page contains the following information:
Column | Description |
---|---|
Customer integration ID | Identifier of the customer profile. It can be used for integration purposes. It is the same across all Applications from the same environment. |
Created | Date and time when the profile was created. |
Last activity | Date and time when the profile was last updated. |
Customer profile overview
To access all the information for the corresponding customer profile, click a Customer integration ID.
The profile page displays the following additional information:
-
Environment: Environment of the customer profile, which corresponds to the environment of the Application where the profile was created.
importantCustomer profiles from a given environment can only be accessed from Applications from the same environment.
-
Discounted orders: Number of closed sessions containing any discounts.
-
Undiscounted orders: Number of closed sessions that didn't contain discounts.
-
Accrued discounts: Total discounted amount for all closed sessions.
-
Net revenue: Revenue produced by the customer after deducting all discounts.
-
Tabs with additional information related to the customer profile:
Achievements
Displays all the achievements the customer has participated in.
You can see the following information for each achievement:
Column | Description |
---|---|
Achievement name | The display name of the achievement. |
API name | The API name of the achievement used in the integration layer. |
Campaign ID | The ID of the campaign this achievement belongs to. |
Progress | The current progress of the customer in the achievement. |
Target | The target value that the customer must reach to complete the achievement. |
Status | Indicates whether the achievement is in progress, expired, or completed. |
Start | Date and time when the customer started the achievement. |
End | Date and time when the achievement ends and resets for the customer. |
Completed on | Date and time when the customer completed the achievement. |
Attributes
Displays any attributes that exist for this customer in the Application. For example, attributes may refer to the customer's gender, language, or shipping country.
Budgets
Displays all the profile budgets applied to this customer profile. You can see the following information for each profile budget:
Column | Description |
---|---|
Campaign | Campaign where the profile budget was created. |
Action | Action that is limited in the budget settings. |
Coupon value | Name of any per-profile coupon used by the customer. |
Used | Bar and counter representing the profile budget usage in relation to the defined limit. |
Limit period | Start and end dates of the recurrence period defined for the profile budget. |
Resets | Budget recurrence period. It indicates how often the budget is reset. |
You can search the displayed results by campaign name and coupon code. To do so, provide the exact search string.
Coupons
Displays all the coupons that have this customer profile as the coupon's recipient integration ID. You can see the following information for each coupon:
Column | Description |
---|---|
Coupon | Name of the coupon. |
Status | Status of the coupon. It can be:
|
Created | Date of creation of the coupon. |
Campaign | Name of the campaign that the coupon is part of. |
Session | Link to the Sessions tab, which shows all the sessions associated with the coupon. |
Redemptions | Number of times a coupon has been successfully redeemed out of the total redemption limit. |
Attributes | Coupon attributes defined in your account together with the values added during the coupon creation process. Attributes are used to build custom logic inside your rules and allow you to create advanced coupon campaigns. |
To edit a coupon, in the Edit column of the coupon, click .
Loyalty cards
Displays all the loyalty cards registered by the customer. You can see the following information for each card:
Column | Description |
---|---|
Code | The loyalty card identification code. |
Status | Indicates whether the card is active, inactive, or blocked. |
Registered | Date and time when the customer profile was linked to the card, displayed in your operating system's time zone (detected by your browser). |
Loyalty points
Displays all the point transactions for profile-based loyalty programs that are active in the Application.
Displaying loyalty point transactions
To display the point transactions for a specific loyalty program and ledger:
-
On the left-side menu of your Application, click Customers.
-
Select the Customer Integration ID of your choice and click the Loyalty Points tab.
-
In Loyalty Program, select the program whose point transactions you want to display.
-
(Optional) In Ledger, select the ledger whose point transactions you want to display.
noteTo display the point transactions of the main ledger and all the subledgers, select All ledgers.
This tab displays the following information for a specific ledger:
- Tier: The loyalty tier that the customer belongs to.
- Current pending points: The number of pending points that were awarded but are not available until their start date and time.
- Current active points: The number of active points currently available in the customer's loyalty balance.
The tab also contains a table with additional information about each point transaction:
Column | Description | |
---|---|---|
Created on | Date and time when the transaction occurred, displayed in your operating system's time zone (detected by your browser). | |
Points | Number of added or deducted points | |
Ledger | Ledger the loyalty points are assigned to. This is only visible when you select All ledgers from the Ledger dropdown. | |
Reason | Reason why the transaction occurred. | |
Expires on | Expiration date of the loyalty points. | |
Active on | Activation date of the loyalty points. | |
Session | Session where the transaction occurred. note If the points were manually added or deducted, this information appears instead of the session. |
Creating a subledger
To create a new subledger in your loyalty program and add points to it:
- On the left-side menu of your Application, click Customers.
- Select the Customer Integration ID of your choice and click the Loyalty Points tab.
- In Loyalty program, select the program where you want to create the subledger.
- Click > Create Subledger.
- In Subledger ID, enter the ID of the subledger.
- In Points, enter the number of points you want to add to the customer's wallet.
- In Reason, enter the reason for adding the points.
- In Reward start, select when the points become active.
-
With Program default, the points become active based on the date set in the loyalty program.
-
With Immediate, the points become active immediately.
-
In Custom, you can choose Relative start or Absolute start.
Examples: Relative reward start
For all the examples mentioned in this table, we assume that the customer session closes on
12 October 2024, 07:20:50
.Relative reward start date Points become active on 10
minute(s) after the session12 October 2024, 07:30:50
1
hour(s) after the session12 October 2024, 08:20:50
5
day(s) after the session17 October 2023, 07:20:50
5
day(s) after the session, start of the day17 October 2024, 00:00:00
5
day(s) after the session, end of the day17 October 2024, 23:59:59
1
week(s) after the session19 October 2024, 07:20:50
1
week(s) after the session, on the last Sunday20 October 2024, 23:59:59
1
month(s) after the session12 November 2024, 07:20:50
1
month(s) after the session, on the last day of the month30 November 2024, 23:59:59
-
- In Reward expiration, select when the ponts expire.
-
With Program default, the points expire based on the date set in the loyalty program.
-
With Unlimited, the points stay active for an unlimited period of time.
-
In Custom, you can choose Relative expiration or Absolute expiration.
Examples: Relative reward expiration
For all the examples mentioned in this table, we assume:
- The customer session closes on
12 October 2024, 07:20:50
. - The rewarded loyalty points are active immediately.
Reward expiration Points expire on 10
minute(s) after the session12 October 2024, 07:30:50
1
hour(s) after the session12 October 2024, 08:20:50
5
day(s) after the session17 October 2023, 07:20:50
5
day(s) after the session, start of the day17 October 2024, 00:00:00
5
day(s) after the session, end of the day17 October 2024, 23:59:59
1
week(s) after the session19 October 2024, 07:20:50
1
week(s) after the session, on the last Sunday20 October 2024, 23:59:59
1
month(s) after the session12 November 2024, 07:20:50
1
month(s) after the session, on the last day of the month30 November 2024, 23:59:59
- The customer session closes on
-
- Click Create Subledger.
Manually adding loyalty points
To manually add loyalty points to your customer's wallet:
- On the left-side menu of your Application, click Customers.
- Select the Customer Integration ID of your choice and click the Loyalty Points tab.
- In Loyalty program, select the program to which you want to add points.
- In Ledger, select the ledger to which you want to add points.
- Click > Add Points.
- In Points, enter the number of points to add to the customer's wallet.
- In Reason, enter the reason for adding the points.
- In Reward start, select when the points become active.
-
With Program default, the points become active based on the date set in the loyalty program.
-
With Immediate, the points become active immediately.
-
In Custom, you can choose Relative start or Absolute start.
Examples: Relative reward start
For all the examples mentioned in this table, we assume that the customer session closes on
12 October 2024, 07:20:50
.Relative reward start date Points become active on 10
minute(s) after the session12 October 2024, 07:30:50
1
hour(s) after the session12 October 2024, 08:20:50
5
day(s) after the session17 October 2023, 07:20:50
5
day(s) after the session, start of the day17 October 2024, 00:00:00
5
day(s) after the session, end of the day17 October 2024, 23:59:59
1
week(s) after the session19 October 2024, 07:20:50
1
week(s) after the session, on the last Sunday20 October 2024, 23:59:59
1
month(s) after the session12 November 2024, 07:20:50
1
month(s) after the session, on the last day of the month30 November 2024, 23:59:59
-
- In Reward expiration, select when the ponts expire.
-
With Program default, the points expire based on the date set in the loyalty program.
-
With Unlimited, the points stay active for an unlimited period of time.
-
In Custom, you can choose Relative expiration or Absolute expiration.
Examples: Relative reward expiration
For all the examples mentioned in this table, we assume:
- The customer session closes on
12 October 2024, 07:20:50
. - The rewarded loyalty points are active immediately.
Reward expiration Points expire on 10
minute(s) after the session12 October 2024, 07:30:50
1
hour(s) after the session12 October 2024, 08:20:50
5
day(s) after the session17 October 2023, 07:20:50
5
day(s) after the session, start of the day17 October 2024, 00:00:00
5
day(s) after the session, end of the day17 October 2024, 23:59:59
1
week(s) after the session19 October 2024, 07:20:50
1
week(s) after the session, on the last Sunday20 October 2024, 23:59:59
1
month(s) after the session12 November 2024, 07:20:50
1
month(s) after the session, on the last day of the month30 November 2024, 23:59:59
- The customer session closes on
-
- Click Add Points.
Manually deducting loyalty points
To manually deduct loyalty points from your customer's wallet:
- On the left-side menu of your Application, click Customers.
- Select the Customer Integration ID of your choice and click the Loyalty Points tab.
- In Loyalty program, select the program from which you want to deduct points.
- In Ledger, select the ledger from which you want to deduct points.
- Click > Deduct Points.
- In Points, enter the number of points to deduct from the customer's wallet.
- In Reason, enter the reason for deducting the points.
- Click Deduct Points.
Exporting the transaction logs
To export a CSV file with all the loyalty point transactions:
-
On the left-side menu of your Application, click Customers.
-
Select the Customer Integration ID of your choice and click the Loyalty Points tab.
-
Click > Export transaction log.
-
In Transaction logs after, select the initial date.
-
(Optional) In Transaction logs before, select the end date.
-
In Integration ID, enter the ID of the customer.
-
In Date format, select the date format of your choice.
noteIn the exported file, all timestamp values follow
UTC+00:00
. -
Click Export Data.
Referred customers
Displays all the users referred by this customer in a table with the following information:
Column | Description |
---|---|
Session ID | Identifier of the customer session. You can access all the data about a session by clicking its ID. |
Code | Referral code that was used by the referred user. |
Referred customer | Integration ID of the referred customer. |
Sessions
Displays the customer sessions and information about coupons and referrals. It also allows you to return cart items.
Column | Description |
---|---|
Session ID | Identifier of the customer session. You can access all the data about a session by clicking its ID. |
Customer integration ID | Identifier of the customer profile. |
State | Indicates whether the session is |
Return items | Allows you to return one or more cart items purchased by the customer in the session. |
Returned items | Number of returned items. |
Items in session | Number of items currently in the customer session. |
Coupon | Any coupons redeemed by the customer in the session. |
Referral code | Any referral codes used by the customer in the session. |
Created | Date and time when the session was created. |