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/publisher/ID/get-orders.csv

Wert	Beschreibung
www.domain.de	System-Partnerprogramm
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-API Filter

~~Transaktions~~Parameter

~~Status~~

Wert

Beschreibung

Beispiel

condition[period][from]

Startdatum

Definition des Startdatums

condition[period][from]=19.12.1909

condition[period][to]

Enddatum

Definition des Enddatums

condition[period][to]=19.12.1909

condition[dynamicdate]

currentmonth = aktueller Monat
lastmonth = letzter Monat
last10d = letzten 10 Tage
currentweek = Aktuelle Woche

Definition eines dynamischen Zeitraums.
(kann nicht zusammen mit condition[period][from] oder condition[period][to] ausgewählt werden.

condition[dynamicdate]=currentweek

condition[l:projects]

Zahlenwert, entsprechend des Projekts

Alle Transaktionen, welche unter der entsprechenden Projekt-ID des Programms hinterlegt sind. Mehrfachnennung möglich.

condition[l:projects]=1234

condition[l:campaigns]

Zahlenwert, entsprechend der Kampagne

Alle Transaktionen, welche unter der entsprechenden Kampagne des Programms hinterlegt sind. Mehrfachnennung möglich.

condition[l:campaigns]=1

condition[timetype]

0 = Transaktionsdatum

1 = Validierungsdatumdatum

2 = Auszahlungsdatum

Alle Transaktionen, welche in einem bestimmten Zeitraum erstellt/ generiert/ validiert worden sind.

condition[timetype]=1

Nachbuchungen per API abfragen

Über die API ist es möglich, Nachbuchungen (Booking Requests) auszulesen.
Dies kann durch Hinzufügen eines speziellen Parameters zum API-Aufruf erfolgen.

Parameter	Wert	Beschreibung	Beispiel
`condition[show_bookingrequests]`	`true` / `false`	Zeigt alle Nachbuchungen an, die über das System hochgeladen wurden	`condition[show_bookingrequests]=true`

Beispiel:

Definition der Felder in der Transaktions-API

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

Feldname	Beschreibung
`criterion`	Gehashter Ordertoken
`trackingtime`	Zeitpunkt der Transaktion
`advertiser_id`	ID des Advertisers
`campaign_title`	Name der Kampagne
`campaign_id`	ID der Kampagne
`project_id`	ID des Projekts
`project_title`	Titel des Projekts
`event`	Typ der Transaktion (z. B. lead, sale, bonus)
`payoutdate`	Auszahlungsdatum – leer, wenn noch nicht ausgezahlt
`processingdate`	Bearbeitungsdatum – leer, wenn noch nicht bearbeitet
`salary_id`	Interne Salary-ID
`salary`	Gutschrifts-ID
`clicktime`	Zeitpunkt des Klicks
`subid`	Übermittelte Sub-ID
`referrer`	Klick-Referrer (Standardwert: `://NONE`)
`admedia_id`	ID des Werbemittels (Admedia-ID)
`status`	Status der Transaktion: `0` = offen `1` = bestätigt `2` = storniert `3` = ausgezahlt
`reason_of_cancellation`	Grund der Stornierung (falls vorhanden)
`provision`	Provision (Commission)
`turnover`	Umsatz
`trigger_id`	ID des Triggers
`trigger_title`	Name des Triggers
`basket_count`	Anzahl der Basket-Items, falls Basket-Tracking aktiv ist (ansonsten `0`)