Sign in

v1

latestOpenAPI 3.1.02026-08-04170116.0 KB
Data Out

Get Customer Journey Attribution Data

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

post/attribution/get-orders-with-journeys-v2

Request body

shopstring required

The exact Shop URL (e.g., 'example.myshopify.com'). Must match the Shop URL value shown in Settings → Store. The API key owner must also have access to the shop, otherwise the request will return 403.

startDatestring required

The start date or timestamp for the requested data period. Must be in ISO 8601 format.

endDatestring required

The end date or timestamp for the requested data period. Must be in ISO 8601 format.

pagenumber

The page number of results to return, starting from 1. Use this to paginate through the data.

pageSizenumber

The number of results per page. Must be between 1 and 100.

excludeJourneyDataboolean

Set this to true to exclude journey data from the response.

Example request

{
  "shop": "madisonbraids.myshopify.com",
  "startDate": "2021-01-01T00:00:00.000-0400",
  "endDate": "2021-01-01T23:59:59.999-0400",
  "page": 2,
  "pageSize": 25
}

Response

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

totalForRangenumber required

The total number of orders within the requested date range.

countnumber required

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

startDatestring required

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

endDatestring required

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

pagenumber

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

earliestDatestring required

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

errorstring

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

Example response

{
  "startDate": "2021-01-01T00:00:00.000-0400",
  "endDate": "2021-01-01T23:59:59.999-0400",
  "ordersWithJourneys": [
    {
      "currency": "USD"
    }
  ]
}