TAtalon
Analytics

Export customer sessions

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Download a CSV file containing the customer sessions that match the request.

[!important] Archived sessions cannot be exported. See the retention policy.

[!tip] If the exported CSV file is too large to view, you can split it into multiple files.

  • id: The internal ID of the session.
  • firstsession: Whether this is a first session.
  • integrationid: The integration ID of the session.
  • applicationid: The ID of the Application.
  • profileid: The internal ID of the customer profile.
  • profileintegrationid: The integration ID of the customer profile.
  • created: The timestamp when the session was created.
  • state: The state of the session.
  • cartitems: The cart items in the session.
  • discounts: The discounts in the session.
  • total: The total value of cart items and additional costs in the session, before any discounts are applied.
  • attributes: The attributes set in the session.
  • closedat: Timestamp when the session was closed.
  • cancelledat: Timestamp when the session was cancelled.
  • referral: The referral code in the session.
  • identifiers: The identifiers in the session.
  • additional_costs: The additional costs in the session.
  • updated: Timestamp of the last session update.
  • store_integration_id: The integration ID of the store.
  • loyaltycards: The identifier of the loyalty card used in the session. A session can have only one loyalty card.
  • updatecount: The number of times the session was updated. When the session is created, this value is initialized to 1.
  • coupons: Coupon codes in the session.
  • rewards: The integration IDs of the unlocked rewards that can be used in the session.
get/v1/applications/{applicationId}/export_customer_sessions

Request

Path parameters

applicationIdinteger required

The ID of the Application. It is displayed in your Talon.One deployment URL.

Query parameters

createdBeforestring date-time

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.

createdAfterstring date-time

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.

updatedBeforestring date-time

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.

updatedAfterstring date-time

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.

profileIntegrationIdstring

Only return sessions for the customer that matches this customer integration ID.

dateFormat'excel' | 'ISO8601'

Determines the format of dates in the export document.

customerSessionState'open' | 'closed' | 'partially_returned' | 'cancelled'

Filter results by state.

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.