Transaktions API - Dokumentation

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

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

---

API-Aufruf

---

Transaktions-API Filterung

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

Transaktions Status

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

Hinweis: Es ist eine Kombination aus mehreren Status möglich.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.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ührtenausgeführten Tags
delivered_tagcode_serversided_url	ÜbermittelterÜbermittelter Server-Side-Trackingcall
ordertoken	Vom Advertiser übermittelteübermittelte Bestellnummer
source	Quelle der Transaktion
project_id	ID des Projekts, dem die Transaktion zugeordnet wurde
admedia_id	Werbemittel-ID, überüber die die Transaktion erzeugt wurde
type	Typ der Transaktion (z.B. Sale, Lead, View)
commission	Provision, die dem Publisher zugeordnet wurde (wird beim Salesabgleich geupdated)
source_commission	Ursprüngliche Provision (wird nicht geupdated)
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übermittelt wurde
trigger_value	Vergütung,Vergütung, die in der entsprechenden Trigger-ID zum Zeitpunkt der Transaktion hinterlegt war
trigger_type	Art des Triggers (FixvergütungFixvergütung oder prozentuale Vergütung)Vergütung)
turnover	Provisionsrelevanter Bestellwert
attributed_turnover	Attribuierter Bestellwert (falls Attributionsmodell aktiv)
original_turnover	Bestellwert in der Advertiser-WährungWährung
action_id	Action-ID, die bei der Transaktion übermitteltübermittelt wurde
salary_id	ID des Auszahlungsvorgangs, in dem die Transaktion abgerechnet wurde
session_id	Session-ID, die bei der Transaktion übermitteltübermittelt wurde
order_currency	WährungWährung der Bestellung
status_change_date	Datum der letzten StatusänderungStatusänderung
cancel_reason	Stornogrund, falls die Transaktion storniert wurde
source_turnover	Vom Advertiser übermittelterübermittelter Bestellwert
last_change	Timestamp der letzten ÄnderungÄnderung der Transaktion
user_agent	Clientinformationen des Nutzers, der die Transaktion ausgelöstausgelö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ürfür den Publisher
order_timestamp	Timestamp des Orderaufrufs
action_timestamp	Timestamp der Action, die zur Order führtefü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
advertiser_title	Name des Advertisers, dem die Transaktion zugeordnet wurde
publisher_id	ID des Publishers, dem die Transaktion zugeordnet wurde
referrer	Seite, auf der der klickauslösendeklickauslösende Vorgang stattfand
country	Land, in dem die Transaktion erzeugt wurde
subid	Sub-ID, die bei der Transaktion übermitteltü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ürfür den Publisher
external_sources_entity_id	(Account) Id der externen Quelle
external_sources_currency_code	Währungscode aus der externen Quelle
external_sources_currency_rate	Umrechnungsrate anhand des external_sources_currency_code und der internen Währung
external_sources_turnover	Bestellwert aus der externen Quelle
source_project_id	Publisher/Project-ID aus der externen Quelle
source_project_title	Publisher/Project-Name aus der externen Quelle
turnover_brutto	Bestellwert inkl. Steuern