# Touchpoints / Customerjourney API - Dokumentation

Die Customerjourney Orders API dient dem Export und der Analyse von Customer-Journey-Daten, die über das Partnerprogramm-System erfasst wurden. Sie ermöglicht es, detaillierte Informationen zu den einzelnen Kontaktpunkten (Actions) einer Bestellung strukturiert als CSV-Datei abzurufen und die Pfade der Nutzer bis zur Conversion präzise nachzuvollziehen.

Die API kann im User-Interface unter dem Menüpunkt **Daten-API** verwendet werden.

---

## API-Aufruf

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

| Wert | Beschreibung |
| :--- | :--- |
| **DOMAIN** | System-Partnerprogramm Domain |
| **ACCESS-TOKEN** | Access Token des Users |
| **ID** | User-ID |
| **.csv** | Art des Downloads (Dateiformat) |

---

## Customerjourney-API Filterung

Für die Customerjourney API können verschiedene Parameter als Filter verwendet werden. Nachfolgend eine Übersicht der verfügbaren Parameter:

| Parameter | Wert / Beispiel | Beschreibung |
| :--- | :--- | :--- |
| **condition[period][from]** | 2026-02-04 | Definiert das Startdatum des Zeitraums (Bestelldatum). |
| **condition[period][to]** | 2026-02-04 | Definiert das Enddatum des Zeitraums (Bestelldatum). |
| **condition[dynamicdate]** | `currentmonth`, `lastmonth`, `last10d`, `currentweek` | Definition eines dynamischen Zeitraums. **Hinweis:** Kann nicht zusammen mit `period[from]` oder `period[to]` verwendet werden. |
| **condition[l:campaigns]** | 1 | Filtert alle Daten, die einer bestimmten Kampagne zugeordnet sind. Mehrfachnennung möglich. |
| **condition[l:projects]** | 1234 | Alle Transaktionen, welche unter der entsprechenden Projekt-ID des Programms hinterlegt sind. Mehrfachnennung möglich. |

**Beispiele für gefilterte Aufrufe:**
* **Fixer Zeitraum:** `condition[period][from]=2026-02-04&condition[period][to]=2026-02-04&condition[l:campaigns]=1`
* **Dynamisch:** `condition[dynamicdate]=currentweek&condition[l:projects]=1234`

---

## Definition der Felder (Spalten)

Die heruntergeladenen Transaktionen enthalten folgende Spalten:

| Feldname | Beschreibung |
| :--- | :--- |
| **order_id** | Interne ID der zugehörigen Transaktion / Bestellung |
| **ordertoken** | Bestellnummer der Transaktion aus dem Shopsystem |
| **campaign_id** | ID der Kampagne, welcher die Bestellung zugeordnet ist |
| **order_timestamp** | Zeitpunkt des Bestelleingangs (Format: YYYY-MM-DD HH:MM:SS+TZ) |
| **trigger_id** | ID des Triggers, der der Bestellung zugeordnet ist |
| **project_id** | ID des Projekts (Attribution Target) |
| **admedia_id** | ID des Werbemittels der Bestellung |
| **action_timestamp** | Zeitpunkt des Klicks oder der Einblendung (Touchpoint) |
| **type** | Art des Kontaktpunkts (z.B. click) |
| **action_campaign_id** | Kampagnen-ID des spezifischen Kontaktpunkts innerhalb der Journey |
| **action_project_id** | Projekt-ID des spezifischen Kontaktpunkts |
| **action_admedia_id** | Werbemittel-ID des spezifischen Kontaktpunkts |
| **referrer** | Die URL, von der der Nutzer zum Shop geleitet wurde (inkl. Tracking-Parametern) |