Transaktions API - Dokumentation

Die Transaktions API ermöglicht den strukturierten Export und die Analyse von Transaktionen, die im Rahmen des Partnerprogramm-Systems erfasst wurden. Sie bietet detaillierte Einblicke in einzelne Transaktionsvorgänge und unterstützt bei der Abrechnung, Erfolgsmessung sowie der Integration in interne oder externe Systeme.

Alle APIs können im User-Interface unter dem Menüpunkt Daten-API verwendet werden.

API-Aufruf

https://www.domain.de/api//ACCESS-TOKEN/advertiser/ID/get-orders.csv

Wert	Beschreibung
www.domain.de	Systemdomain
ACCESS-TOKEN	Access Token des Users
ID	User-ID
.csv	Art des Downloads

Transaktions-API Filterung

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

Transaktions Status

Parameter	Wert	Beispiel	Beschreibung
`condition[l:status]`	`open`	`condition[l:status]=open`	Alle Transaktionen, welche als “Offen” im System hinterlegt sind
	`confirmed`	`condition[l:status]=confirmed`	Alle Transaktionen, welche als “Bestätigt” im System hinterlegt sind
	`paid`	`condition[l:status]=paid`	Alle Transaktionen, welche als “Ausgezahlt” im System hinterlegt sind
	`canceled`	`condition[l:status]=canceled`	Alle Transaktionen, welche als “Storniert” im System hinterlegt sind

Hinweis: Es ist eine Kombination aus mehreren Status möglich. Zum Beispiel: condition[l:status]=confirmed,paid

Parameter	Wert / Beispiel	Beschreibung
`condition[period][from]`	`01.01.2025`	Definiert das Startdatum des Zeitraums
`condition[period][to]`	`31.01.2025`	Definiert das Enddatum des Zeitraums
`condition[l:campaigns]`	`1`	Filtert alle Baskets, die einer bestimmten Kampagne zugeordnet sind. Mehrfachnennung möglich.
`condition[datemode]`	`processing` `payout` `incoming`	Bestimmt die Art des Zeitraums: • `processing`: Baskets, die im Zeitraum validiert wurden • `payout`: Baskets, die im Zeitraum ausgezahlt wurden • `incoming`: Baskets, die im Zeitraum erfasst wurden (Transaktionsdatum)

Beispiel:

Definition der Felder in der Transaktions-API

Die heruntergeladenen Transaktionen (z.B. als .csv) enthalten folgende Spalten:

Feldname	Beschreibung
`id`	Eindeutige ID der Transaktion
`status`	Status der Transaktion
`timestamp`	Zeitpunkt der Transaktion
`campaign_id`	Kampagne, der die Transaktion zugeordnet wurde
`attribution`	Betrag der gezahlten Attribution
`delivered_tagcode_count`	Anzahl der ausgeführten Tags
`delivered_tagcode_serversided_url`	Übermittelter Server-Side-Trackingcall
`ordertoken`	Vom Advertiser übermittelte Bestellnummer
`source`	Quelle der Transaktion
`project_id`	ID des Projekts, dem die Transaktion zugeordnet wurde
`admedia_id`	Werbemittel-ID, über die die Transaktion erzeugt wurde
`type`	Typ der Transaktion (z.B. Sale, Lead, View)
`commission`	Provision, die dem Publisher zugeordnet wurde
`commission_group_id`	Provisionsgruppe, in der sich der Publisher bei Transaktionserzeugung befand
`trigger_id`	Trigger-ID, die der Transaktion zugeordnet ist
`description`	Beschreibung, die bei der Transaktion übermittelt wurde
`trigger_value`	Vergütung, die in der entsprechenden Trigger-ID zum Zeitpunkt der Transaktion hinterlegt war
`trigger_type`	Art des Triggers (Fixvergütung oder prozentuale Vergütung)
`turnover`	Provisionsrelevanter Bestellwert
`original_turnover`	Bestellwert in der Advertiser-Währung
`action_id`	Action-ID, die bei der Transaktion übermittelt wurde
`salary_id`	ID des Auszahlungsvorgangs, in dem die Transaktion abgerechnet wurde
`session_id`	Session-ID, die bei der Transaktion übermittelt wurde
`order_currency`	Währung der Bestellung
`status_change_date`	Datum der letzten Statusänderung
`cancel_reason`	Stornogrund, falls die Transaktion storniert wurde
`source_turnover`	Vom Advertiser übermittelter Bestellwert
`last_change`	Timestamp der letzten Änderung der Transaktion
`user_agent`	Clientinformationen des Nutzers, der die Transaktion ausgelöst hat
`order_actions_id`	Interner Verweis auf den provisionsrelevanten Klick oder Postview
`bonus_id`	ID eines Bonus-Laufs
`customer_journey_status`	Interne Kennziffer zur Customer Journey
`ebestid`	Gehashte Bestellnummer zur Anzeige für den Publisher
`order_timestamp`	Timestamp des Orderaufrufs
`action_timestamp`	Timestamp der Action, die zur Order führte
`trigger_title`	Name des Triggers
`payoutdate`	Auszahlungsdatum
`campaign_group_title`	Titel der Provisionsgruppe
`project_title`	Name des Projekts, dem die Transaktion zugeordnet wurde
`campaign_title`	Name der Kampagne, die der Transaktion zugeordnet wurde
`advertiser_id`	ID des Advertisers, dem die Transaktion zugeordnet wurde
`publisher_id`	ID des Publishers, dem die Transaktion zugeordnet wurde
`referrer`	Seite, auf der der klickauslösende Vorgang stattfand
`country`	Land, in dem die Transaktion erzeugt wurde
`subid`	Sub-ID, die bei der Transaktion übermittelt wurde
`publisher_prename`	Vorname des Publishers (aus Systemdaten)
`publisher_surname`	Nachname des Publishers (aus Systemdaten)
`publisher_searchtitle`	Suchtitel des Publishers (aus Systemdaten)
`basket_items`	Anzahl der Artikel im Warenkorb
`sub_status`	Advertiser-interner Status zur Verwaltung der Transaktion
`visibility`	Sichtbarkeit für den Publisher