Allgemeine Informationen
Über die API können sämtliche Daten, welche zur Verfügung stehen, heruntergeladen und verarbeitet werden. Die API besteht aus verschiedenen Parametern, die angegeben werden müssen, um Zugriff auf die richtigen Daten zu erhalten.
Mögliche Parameter zur Filterung:
Über die API können auf sämtliche Daten, welche im laufe der Zeit angefallen sind, zugegriffen werden. Über die entsprechenden Parameter wird eine Filterung angewendet, um nur die Daten zu erhalten, welche benötigt werden.
Ein Beispielhafter API-Aufruf sieht folgendermaßen aus:
https://www.DOMAIN.de/api//Access-Token/publisher/ID/get-statistic_daily.csv?condition[period][from]=19.12.1909&condition[period][to]=19.12.1909
Um die API aufzurufen, muss zuerst die Domain des entsprechenden Systems hinterlegt werden. Anschließend folgt “/api//” und der Access-Token des Accounts. Wenn der Access-Token nicht bekannt ist, bitte folgender Anleitung folgen:
Wo ist der Access-Token zu finden?
Nun wird nach dem Access-Token ein “/publisher/” angehangen und dann die Publisher ID innerhalb des Systems. Wenn die Publisher ID nicht bekannt ist, bitte folgender Anleitung folgen:
Wo ist die Publisher ID zu finden?
Anschließend wird die Art des API Aufrufs bestimmt. Welche hierbei zur Verfügung stehen kann folgenden Anleitungen entnommen werden:
Zum Schluss kann entschieden werden, in welchem Format die Daten bereitgestellt werden sollen. Die Ausgabe der Datei ist in CSV, XLS, XML sowie JSON möglich. Hierfür muss die Datei-Endung entsprechend angepasst werden. Das CSV Dateiformat wird empfohlen!
Verfügbare Datenarten
Dateiformat | Parameter |
|---|---|
CSV Dateiformat - Kommagetrennt | .csv |
XLS Dateiformat - Standarddateiformat Microsoft Excel | .xls |
XML Dateiformat - Dateiformat Microsoft Excel | .xml |
API im Frontend einsehen
Die APIs sind ebenfalls im Frontend zu finden. Dazu muss im eingeloggten Zustand über den Reiter API auf den Punkt Daten-API navigiert werden, wo alle Schnittstellen angeboten werden.
Transaktions – API
Für die Transaktions-API gibt es zusätzliche Parameter, die Abfrage werden können.
Bis hier ist folgender Aufruf bekannt: […]/get-statistic_transactions.csv?[…]
Nachfolgend alle zusätzlichen Parameter, welche abgefragt werden können:
Transaktionsstatus
Parameter | Wert | Beschreibung | Beispiel |
|---|---|---|---|
condition[l:processingstate] | open | Alle Transaktionen, welche als “Offen” im System hinterlegt sind | condition[I:processingstate]=open |
confirmed | Alle Transaktionen, welche als “Bestätigt” im System hinterlegt sind. | condition[I:processingstate]=confirmed | |
paid | Alle Transaktionen, welche als “Ausgezahlt” im System hinterlegt sind. | condition[I:processingstate]=paid | |
canceled | Alle Transaktionen, welche als “Storniert” im System hinterlegt sind. | condition[I:processingstate]=canceled |
Info: Es ist eine Kombination aus mehreren Status möglich. Zum Beispiel: condition[l:processingstate]=confirmed,paid
Weitere Transaktions-API Filter
Parameter | Wert | Beschreibung | Beispiel |
|---|---|---|---|
condition[l:projects] | Zahlenwert, entsprechend des Projekts | Alle Transaktionen, welche unter der entsprechenden Projekt-ID des Programms hinterlegt sind. | condition[l:projects]=1234 |
condition[l:campaigns] | Zahlenwert, entsprechend der Kampagne | Alle Transaktionen, welche unter der entsprechenden Kampagne des Programms hinterlegt sind. | condition[l:campaigns]=1 |
condition[timetype] | 0 = Erstellungsdatum 1 = Bearbeitungsdatum 2 = Auszahlungsdatum | Alle Transaktionen, welche in einem bestimmten Zeitraum erstellt/ generiert/ bearbeitet worden sind. | condition[timetype]=1 |
Definition der Felder in der Transaktions-API
Die Spaltennamen der heruntergeladenen Transaktionen beinhalten folgende Parameter:
criterion | Die verschlüsselte Transaktion-ID |
trackingtime | Zeitpunkt der Transaktion |
advertiser_id | Programm-Betreiber ID |
campaign_title | Name des Programms (Kampagne) |
campaign_id | Programm ID |
project_id | Die ID Ihrer Webseite (Projekt) |
project_title | Titel Ihrer Seite (Projekt) |
event | Art der Transaktion – Lead, Sale, Bonus |
Payoutdate | Auszahlungsdatum – leer wenn noch nicht beglichen, Format: YYYY-MM-DD HH:MM:SS |
processingdate | Bearbeitungszeitpunkt - leer wenn noch nicht bearbeitet, Format: YYYY-MM-DD HH:MM:SS |
salary_id | Interne Auszahlungs ID - -1 bei noch nicht ausgezahlt |
salary | Gutschriftsnummer – Beleg wie unter Einstellungen=>Gutschriften downloadbar |
clicktime | Zeitpunkt des Klicks - Format: YYYY-MM-DD HH:MM:SS |
subid | Die von Ihnen im Klick / Postview übergebene subid – Falls leer, wird NONE wiedergegeben |
referrer | Der Klick-Referrer falls ermittelbar – ansonsten ://NONE |
admedia_id | Werbemittel ID des Klicks der zur Transaktion geführt hat |
status | 0 = offen | 1 = freigegeben | 2 = Storniert | 3 = ausgezahlt |
reason_of_cancellation | Storno-Grund (falls angegeben) |
provision | Ihre Vergütung |
turnover | Netto-Warenkorb Wert |
trigger_id | ID des Events |
trigger_title | Name des Events |
basket_count | Im Falle von Basket-Tracking wird die Anazhl der im Warenkorb befindlichen Artikel wiedergegeben, sonst 0 |