Get Customer Journey Attribution Data

post https://api.triplewhale.com/api/v2/attribution/get-orders-with-journeys-v2

Export full customer journey data, with Triple Pixel attribution, for all customers who placed an order in the specified period.

Responses

Response body

object

totalForRange

number

required

The total number of orders within the requested date range.

count

number

required

The number of orders returned in the current page of results.

startDate

string

required

The start date or timestamp of the requested period in ISO 8601 format.

endDate

string

required

The end date or timestamp of the requested period in ISO 8601 format.

page

number

The page number of the current response. Starts at 1.

ordersWithJourneys

array of objects

required

A list of orders along with their attribution and journey details.

ordersWithJourneys*

object

order_id

number

required

A unique identifier for the order.

created_at

string

required

The timestamp when the order was created, in ISO 8601 format.

order_name

string

required

The name of the order as defined in the e-commerce platform.

attribution

object

required

Attribution details for the order.

customer_id

number

required

The unique identifier for the customer associated with the order.

total_price

string

required

The total price of the order.

currency

string

required

The currency code for the order (e.g., USD, EUR).

journey

array of objects

required

A list of events in the customer journey, such as page views or add-to-cart events, leading to the order.

journey*

object

time

string

required

The timestamp of the journey event, in ISO 8601 format.

event

string

required

The name of the journey event (e.g., page loaded for page views, add2c for add-to-cart actions).

page loaded add2c

path

string

required

The URL path of the event (e.g., /products/product-name).

productId

string

required

The unique identifier of the product associated with the event.

earliestDate

string

required

The earliest date among the orders returned in this response. Returns null if there are no earlier orders.

error

string

An error message if the request failed or encountered an issue.

Headers

object

RateLimit-Policy

string

The rate limit policy for this endpoint, given as {quota};w={window} where window is in seconds and quota is the allowed number of calls a user can make per window.

RateLimit

string

Information about the user's rate limit usage for this endpoint.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.triplewhale.com/api/v2/attribution/get-orders-with-journeys-v2 \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200A successful response containing orders, attribution data, and (optionally) journey events for the requested period.

429Too Many Requests