07 Get Experience Export

post

Export order-level or line-item-level data for an experience (A/B test) as a CSV file.

POST /analytics/experience/{experienceId}/export

Returns a presigned S3 URL to download a CSV file containing the requested export data. The URL is valid for 15 minutes.

Parameters

  • experienceId (path) — required. UUID of the experience.

  • exportTyperequired. Type of export: orders or order_line_items (see table below).

  • startTs — optional 10-digit epoch timestamp in seconds. Defaults to experience start date.

  • endTs — optional 10-digit epoch timestamp in seconds. Defaults to now or experience end date.

  • filters — optional analytics filters object. See below and the Filters Reference for available fields.

Export Types

Value
Description

orders

Order-level data — one row per order with revenue, discount, variation assignment, and visitor

order_line_items

Line-item-level data — one row per line item with product, quantity, price, and variation

Filters

This endpoint accepts the same filters as POST /analytics/resource/{experienceId}. Key filters include:

Field
Type
Description

deviceType

string

"any", "mobile", or "desktop"

visitorType

string

"any", "new", or "returning"

countryCodes

string[]

ISO 3166-1 alpha-2 codes, e.g. ["US", "GB"]

sourceSitesOrChannels

string[]

Traffic channel names (see Filters Reference)

userBehavior

object

Visitor behavior filter (see sub-fields below)

experimentProductsOnly

boolean

Only include products in the experiment (target products)

onlyProductIds

string[]

Shopify product IDs to include

onlyProductHandles

string[]

Shopify product handles to include

userBehavior sub-fields

All fields are optional booleans. Set to true to filter to only visitors who performed that action.

Field
Description

viewedProductPage

Visitor viewed a product page

viewedCollectionPage

Visitor viewed a collection page

addedToCart

Visitor added an item to cart

viewedCheckout

Visitor reached checkout

See the Filters Reference section for the full list of available filter fields.

Response Structure

The response contains:

Field
Type
Description

exportType

string

The export type requested (orders or order_line_items)

experienceId

string

UUID of the experience

experienceName

string

Display name of the experience

url

string|null

Presigned S3 URL to download the CSV. Null if the export timed out.

expiresIn

number

Seconds until the URL expires (900 = 15 minutes). 0 if url is null.

format

string

Always "csv"

message

string

Human-readable status (e.g. "Export ready", "Export timed out, please retry")

Date Range Behavior

  • When startTs and endTs are omitted, the date range defaults to the experience's full lifetime (start date through end/pause date or now).

  • If the experience is paused or ended, the export is automatically truncated at the pause/end date.

  • If the provided startTs is before the experience start date, it is clamped to the experience start. Similarly, endTs is clamped to the experience end/pause date.

Presigned URL

The returned URL is a time-limited presigned S3 URL. It expires after 15 minutes (900 seconds). After expiry, the URL returns a 403 Forbidden. Call the endpoint again to generate a new URL.

Authorizations
intelligems-access-tokenstringRequired

Intelligems external API access token.

Path parameters
experienceIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Body
exportTypestring · enumRequired

Type of export data to retrieve. 'orders' returns order-level data, 'order_line_items' returns line-item-level data.

Possible values:
startTsstringOptional

Optional analysis start timestamp as a 10-digit Unix epoch string in seconds. Defaults to the experience start date.

endTsstringOptional

Optional analysis end timestamp as a 10-digit Unix epoch string in seconds. Defaults to now or the experience end date.

Responses
chevron-right
200

OK

application/json
post
/v25-10-beta/analytics/experience/{experienceId}/export
200

OK

Last updated

Was this helpful?