Export customer sessions
GET {{baseUrl}}/v1/applications/:applicationId/export_customer_sessions?createdBefore=2022-11-08T00:11:22.082Z&createdAfter=2022-11-08T00:11:22.082Z&profileIntegrationId=value&dateFormat=excel&customerSessionState=cancelled
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 the session.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.coupons: Coupon codes in the session.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
createdBefore | string | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | |
createdAfter | string | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | |
profileIntegrationId | string | Only return sessions for the customer that matches this customer integration ID. | |
dateFormat | string | Determines the format of dates in the export document. | |
customerSessionState | string | Filter results by state. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |