Skip to main content

Displaying customer sessions

Customer sessions contain customer activity within a given Application. For example, a customer session can represent a shopping cart or a completed order for a given customer.

Suggested reading

The state of a session can be one of the following:

  • Open: The session can be modified as many times as needed, depending on your business needs. For example, the session may remain open while the customer adds new items to the cart.
  • Closed: The session cannot be modified anymore, unless it is reopened. For example, if the customer has completed the payment step of the order workflow.
  • Cancelled: The session had an issue or the closed or partially returned states are not valid anymore. For example, if the customer requested a full refund or the payment failed at checkout.
  • Partially returned: The closed state is not valid anymore but the session is not cancelled. For example, if the customer requested a refund for some of the items they purchased in the same session.

Each action of the customer in the session is represented by an event. Every session contains at least one event.

Listing customer sessions

To list the customer sessions of an Application:

  1. Open the Application of your choice.
  2. On the left-side menu, click Sessions.

The page contains the following information:

Session integration IDIdentifier of the customer session. It can be used for integration purposes. It is unique for each Application.
Customer integration IDIdentifier of the customer profile. It can be used for integration purposes. It is the same across all Applications.
Store integration IDIdentifier of the store passed in the customer session. It can be used for integration purposes. It is unique for each store.
StateIndicates whether the session is open, closed, partially returned or cancelled.
Learn more about customer sessions in the Developer docs.
Return itemsAllows you to return one or more cart items purchased by the customer in the session.
Returned itemsNumber of returned items.
Items in sessionNumber of items currently in the customer session.
CouponAny coupons redeemed by the customer in the session.
Referral codeAny referral codes used by the customer in the session.
CreatedDate and time when the session was created in the time zone of the Application.

Customer session overview

Click a Session integration ID to access all the information for the corresponding customer session.

The session page displays the following information:

  • Session status: Session state.
  • Session integration ID: Customer session ID.
  • Customer integration ID: Customer ID. You can access the customer profile by clicking the ID.
  • Created: Date and time when the session was created.
  • Last activity: Date and time when the session was last updated.
  • Total discounts: Total discounted amount for the session.
  • Net total: Revenue produced by the customer in the session after deducting all discounts.
  • Tabs with additional information related to the customer session:

Session events

This tab displays all the events and trigger effects of the selected session:

TimeDate and time when the event happened.
EventEvent type.
EffectsNumber of effects triggered for the event. Click the link to display the details of each effect.

You can also list all the effects of the Application.

Session attributes

This tab displays any customer session attributes set in the Application.

For example, attributes may refer to the shipping city, the operating system of the customer's device, or the payment method.


The tab appears only if you set customer session attributes for the Application.

Cart items

This tab displays the cart items as JSON.


The tab appears only if there are any events involving cart items in the session.

Returning individual cart items

You can manually return one or more cart items from a closed or partially returned session.

This is useful, for example, to allow your customer support agents to return specific items when a customer requests a refund for part of their purchase.


If you return one of more cart items using this feature, the session state changes to partially returned if the original state was closed.

Updating the session state can cause rollback effects to undo potential previous effects triggered when you closed or opened the session. Learn more in our Developer docs.

To return individual cart items:

  1. Click for the session that contains the items to be returned.
  2. In the pop-up that appears, select the items you want to return. For each item, you can see in the Returned quantity column how many units have already been returned.
  3. (Optional) Use the Quantity dropdown to select the number of units you want to return for each item.
  4. Click Return Selected Items.

The number of returned items automatically appears in the Returned items column of the session and it is subtracted from the Items in session column.

Exporting customer sessions

Export your customer sessions as a CSV file to import this data in other tools, for example, in any BI tool to run reports.

To export customer sessions:

  1. On the leftmost menu, click Apps.

  2. Select the Application from which you want to export the sessions.

  3. On the Campaigns page, at the top-right corner, click Manage Campaign Data.

  4. Click Export Customer Sessions.

  5. Set your desired time frame:

    • In the Date Range tab, set your desired dates.
    • In the After Recent Export tab, select any previous customer session export from the Created after drop-down menu.
  6. In Customer session state, select the state of your choice.

  7. In Date format, select the date format of your choice.


    In the exported file, all timestamp values follow UTC+00:00.

  8. Click Export Data.