# Touchpoints / Customer Journey API Documentation

The Customer Journey Orders API is used for exporting and analyzing customer journey data recorded via the partner program system. It allows you to retrieve detailed information on individual touchpoints (actions) of an order in a structured CSV format, enabling precise tracking of user paths leading up to a conversion.

The API can be accessed within the user interface under the **Data API** menu item.

---

### API Call

`https://<strong>DOMAIN</strong>/api/<strong>ACCESS-TOKEN</strong>/admin/<strong>ID</strong>/get-customerjourney_orders<strong>.csv</strong>`

<table data-path-to-node="7" id="bkmrk-value-description-do"><thead><tr><td>**Value**</td><td>**Description**</td></tr></thead><tbody><tr><td><span data-path-to-node="7,1,0,0">**DOMAIN**</span></td><td><span data-path-to-node="7,1,1,0">Partner program system domain</span></td></tr><tr><td><span data-path-to-node="7,2,0,0">**ACCESS-TOKEN**</span></td><td><span data-path-to-node="7,2,1,0">User's Access Token</span></td></tr><tr><td><span data-path-to-node="7,3,0,0">**ID**</span></td><td><span data-path-to-node="7,3,1,0">User ID</span></td></tr><tr><td><span data-path-to-node="7,4,0,0">**.csv**</span></td><td><span data-path-to-node="7,4,1,0">Download file format</span></td></tr></tbody></table>

---

### Customer Journey API Filtering

Various parameters can be used as filters for the Customer Journey API. Below is an overview of the available parameters:

<table data-path-to-node="11" id="bkmrk-parameter-value-%2F-ex"><thead><tr><td>**Parameter**</td><td>**Value / Example**</td><td>**Description**</td></tr></thead><tbody><tr><td><span data-path-to-node="11,1,0,0">`condition[period][from]`</span></td><td><span data-path-to-node="11,1,1,0">2026-02-04</span></td><td><span data-path-to-node="11,1,2,0">Defines the start date of the time period (order date).</span></td></tr><tr><td><span data-path-to-node="11,2,0,0">`condition[period][to]`</span></td><td><span data-path-to-node="11,2,1,0">2026-02-04</span></td><td><span data-path-to-node="11,2,2,0">Defines the end date of the time period (order date).</span></td></tr><tr><td><span data-path-to-node="11,3,0,0">`condition[dynamicdate]`</span></td><td><span data-path-to-node="11,3,1,0">`currentmonth`, `lastmonth`, `last10d`, `currentweek`</span></td><td>Defines a dynamic time period.

  
**Note:** Cannot be used in conjunction with `period[from]` or `period[to]`.

</td></tr><tr><td><span data-path-to-node="11,4,0,0">`condition[l:campaigns]`</span></td><td><span data-path-to-node="11,4,1,0">1</span></td><td><span data-path-to-node="11,4,2,0">Filters all data assigned to a specific campaign. Multiple values allowed.</span></td></tr><tr><td><span data-path-to-node="11,5,0,0">`condition[l:projects]`</span></td><td><span data-path-to-node="11,5,1,0">1234</span></td><td><span data-path-to-node="11,5,2,0">Filters all transactions recorded under the corresponding project ID of the program. Multiple values allowed.</span></td></tr></tbody></table>

#### Examples of Filtered API Calls:

- **Fixed Time Period:** `condition[period][from]=2026-02-04&condition[period][to]=2026-02-04&condition[l:campaigns]=1`
- **Dynamic Time Period:** `condition[dynamicdate]=currentweek&condition[l:projects]=1234`

---

### Field Definitions (Columns)

The downloaded transactions contain the following columns:

<table data-path-to-node="17" id="bkmrk-field-name-descripti"><thead><tr><td>**Field Name**</td><td>**Description**</td></tr></thead><tbody><tr><td>`<span data-path-to-node="17,1,0,0"><strong data-index-in-node="0" data-path-to-node="17,1,0,0">order_id</strong></span>`</td><td><span data-path-to-node="17,1,1,0">Internal ID of the associated transaction / order</span></td></tr><tr><td>`<span data-path-to-node="17,2,0,0"><strong data-index-in-node="0" data-path-to-node="17,2,0,0">ordertoken</strong></span>`</td><td><span data-path-to-node="17,2,1,0">Order number of the transaction from the shop system</span></td></tr><tr><td>`<span data-path-to-node="17,3,0,0"><strong data-index-in-node="0" data-path-to-node="17,3,0,0">campaign_id</strong></span>`</td><td><span data-path-to-node="17,3,1,0">ID of the campaign to which the order is assigned</span></td></tr><tr><td>`<span data-path-to-node="17,4,0,0"><strong data-index-in-node="0" data-path-to-node="17,4,0,0">order_timestamp</strong></span>`</td><td><span data-path-to-node="17,4,1,0">Timestamp of the order receipt (Format: YYYY-MM-DD HH:MM:SS+TZ)</span></td></tr><tr><td>`<span data-path-to-node="17,5,0,0"><strong data-index-in-node="0" data-path-to-node="17,5,0,0">trigger_id</strong></span>`</td><td><span data-path-to-node="17,5,1,0">ID of the trigger assigned to the order</span></td></tr><tr><td>`<span data-path-to-node="17,6,0,0"><strong data-index-in-node="0" data-path-to-node="17,6,0,0">project_id</strong></span>`</td><td><span data-path-to-node="17,6,1,0">ID of the project (Attribution Target)</span></td></tr><tr><td>`<span data-path-to-node="17,7,0,0"><strong data-index-in-node="0" data-path-to-node="17,7,0,0">admedia_id</strong></span>`</td><td><span data-path-to-node="17,7,1,0">ID of the ad media used for the order</span></td></tr><tr><td>`<span data-path-to-node="17,8,0,0"><strong data-index-in-node="0" data-path-to-node="17,8,0,0">action_timestamp</strong></span>`</td><td><span data-path-to-node="17,8,1,0">Timestamp of the click or impression (Touchpoint)</span></td></tr><tr><td>`<span data-path-to-node="17,9,0,0"><strong data-index-in-node="0" data-path-to-node="17,9,0,0">type</strong></span>`</td><td><span data-path-to-node="17,9,1,0">Type of touchpoint (e.g., `click`)</span></td></tr><tr><td>`<span data-path-to-node="17,10,0,0"><strong data-index-in-node="0" data-path-to-node="17,10,0,0">action_campaign_id</strong></span>`</td><td><span data-path-to-node="17,10,1,0">Campaign ID of the specific touchpoint within the journey</span></td></tr><tr><td>`<span data-path-to-node="17,11,0,0"><strong data-index-in-node="0" data-path-to-node="17,11,0,0">action_project_id</strong></span>`</td><td><span data-path-to-node="17,11,1,0">Project ID of the specific touchpoint</span></td></tr><tr><td>`<span data-path-to-node="17,12,0,0"><strong data-index-in-node="0" data-path-to-node="17,12,0,0">action_admedia_id</strong></span>`</td><td><span data-path-to-node="17,12,1,0">Ad media ID of the specific touchpoint</span></td></tr><tr><td>`<span data-path-to-node="17,13,0,0"><strong data-index-in-node="0" data-path-to-node="17,13,0,0">referrer</strong></span>`</td><td><span data-path-to-node="17,13,1,0">The URL from which the user was redirected to the shop (including tracking parameters)</span></td></tr></tbody></table>