# Publisher API - Dokumentation # Basket API – Dokumentation Die Basket API dient dem Export und der Analyse von Warenkorb-Daten, die über das Partnerprogramm-System erfasst wurden. Sie ermöglicht es, detaillierte Informationen zu einzelnen Basket-Items strukturiert als CSV-Datei abzurufen und weiterzuverarbeiten. Die API kann im User-Interface unter dem Menüpunkt **Daten-API** verwendet werden. --- ## API-Aufruf
https://**www.domain.de**/api//**ACCESS-TOKEN**/publisher/**ID**/get-orders_baskets**.csv**
WertBeschreibung
www.domain.deSystem-Partnerprogramm
ACCESS-TOKENAccess Token des Users
IDUser-ID
.csvArt des Downloads
--- ## Basket-API Filterung Für die Basket API können verschiedene Parameter als Filter verwendet werden. Nachfolgend eine Übersicht aller verfügbaren Parameter:
ParameterWert / BeispielBeschreibung
`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:**
`condition[period][from]=01.01.2025&condition[period][to]=31.01.2025&condition[datemode]=processing`
---
## Definition der Felder in der Basket-API Die heruntergeladenen Transaktionen (z.B. als `.csv`) enthalten folgende Spalten:
FeldnameBeschreibung
`id` Einzigartige ID der Transaktion.
`timestamp` Zeitpunkt der Transaktion.
`trigger_type` Art des Triggers (Fixvergütung, prozentuale Vergütung).
`ebestid` Die vollständig gehashte Bestellnummer.
`coatoken` Teilweise gehashte Bestellnummer. Wird genutzt, wenn bspw. eine Transaktion
`ordertoken` Die Bestellnummer der Transaktion
`trigger_id` Trigger ID, welche der Transaktion zugeordnet wird.
`is_basket` Gibt an, ob es sich um ein Basket-Item handelt (`true` / `false`)
`basket_item` Eindeutige ID des Basket-Items
`category` Übergebene Kategorie des Shops
`productid` Die ID des Produkts aus dem Shop.
`productname` Der Name des Produkts aus dem Shop.
`amount` Die Anzahl der gekauften Produkte im Shop.
`price` Der Stückpreis des Produkts.
`original_price` Der ursprüngliche Stückpreis eines Produkts, bevor Änderungen vorgenommen wurden.
`status` Der Status des Artikels.
`total` Der Gesamtpreis für die entsprechende Anzahl der Artikel.
`commission` Provision, für das Basket-Item
`commission_rate` Provisionsrate, für das Basket-Item
`attribution` Die Attribution pro Warenkorbitem.
`currency` Die Währung des Shops.
`attributed_total`Attribuierter Preis × Anzahl
`trigger_value`Provisionshöhe pro Basket-Item
`original_turnover`Getrackter Umsatz
`price_brutto`Brutto-Preis des Basket-Items
# 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**
WertBeschreibung
www.domain.deSystem-Partnerprogramm
ACCESS-TOKENAccess Token des Users
IDUser-ID
.csvArt 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
**Parameter** **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.
ParameterWertBeschreibungBeispiel
`condition[show_bookingrequests]``true` / `false`Zeigt alle Nachbuchungen an, die über das System hochgeladen wurden`condition[show_bookingrequests]=true`
**Beispiel:**
`get-statistic_campaign.csv?condition[show_bookingrequests]=true`
---
## Definition der Felder in der Transaktions-API Die heruntergeladenen Transaktionen (z.B. als `.csv`) enthalten folgende Spalten:
FeldnameBeschreibung
`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`)
# Statistik API - Dokumentation Die Statistik API ermöglicht den Export und die Auswertung aggregierter Leistungsdaten im Rahmen des Partnerprogramm-Systems. Sie stellt unterschiedliche Statistik-Arten bereit, wie z. B. Auswertungen nach Tag, Kampagne, Projekt oder Werbemittel, und unterstützt so bei der Performance-Analyse und Optimierung. 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-statistic_**daily.csv**
WertBeschreibung
www.domain.deSystem-Partnerprogramm
ACCESS-TOKENAccess Token des Users
IDUser-ID
get-statistic\_{Statistik-Art}Art der Statistik (z.B. Tagesbasiert, etc.)
.csvArt des Downloads
## Statistik-API Filterung
Für die Statistik API können verschiedene Parameter als Filter verwendet werden. Nachfolgend eine Übersicht aller verfügbaren Parameter:
**Statistik-Arten**
Statistik-ArtParameter
Statistik nach Tag`get-statistic_daily`
Statistik nach Kampagnen`get-statistic_campaign`
Statistik nach Werbemittel`get-statistic_media`
Statistik nach Projekt`get-statistic_project`
Statistik nach SubID`get-statistic_subid`
Statistik nach Referrer`get-statistic_referrer`
Statistik nach Trigger`get-statistic_trigger`
Statistik nach Transaktionen`get-statistic_transactions`
Statistik nach Baskets`get-orders_baskets`
ParameterWert / BeispielBeschreibung
`condition[period][from]``01.01.2025`Startdatum der Statistik
`condition[period][to]``31.01.2025`Enddatum der Statistik
`condition[paymentstatus]``all` = alle `0` = nicht ausgezahlt `1` = ausgezahltFiltert nach Auszahlungsstatus
`condition[dynamicdate]``currentmonth` = aktueller Monat `lastmonth` = vorheriger Monat `currentweek` = aktuelle Woche `last10d` = letzte 10 TageDynamische Zeiträume
`condition[project_id]``Zahl / ID condition[project_id]=12345`Filtert nach Projekt‑ID(s)
`condition[l:campaigns]`Kampagnen‑IDFiltert nach Kampagne(n)
`condition[bruttodata]` / `condition[bruttodaten]``true`/`false`Filtert nach Bruttozahlen
`condition[ignormandant] /``condition[ignoremandant]``true`/`false`Begrenzung auf eine Kampagne oder nicht
**Definition der Felder in der Statistik API** Die Spaltennamen der heruntergeladenen Datei beinhalten folgende Parameter:
**Feldname** **Beschreibung**
`criterion` Das Kriterium, welches für die Statistik ausgewählt wurde. Wurde beispielsweise die Statistik nach Tag ausgewählt, werden in diesem Feld die betroffenen Tage ausgegeben. Wird Statistik nach Campagne ausgewählt, werden hier die entsprechenden Kampagnen-ID ausgewählt. In der Regel wird hier die ID ausgegeben.
`title` Der Name der entsprechend ausgewählten Criterion. Hier steht z. B. der Name der Kampagne oder des Projekts.
`leads_open_count` Anzahl der offenen Leads.
`leads_confirmed_count` Anzahl der bestätigten Leads.
`leads_canceled_count` Anzahl der stornierten Leads.
`sales_open_count` Anzahl der offenen Sales.
`sales_confirmed_count` Anzahl der bestätigten Sales.
`sales_canceled_count` Anzahl der stornierten Sales.
`all_open_count` Anzahl der offenen Leads und Sales addiert.
`all_confirmed_count` Anzahl der bestätigten Leads und Sales addiert.
`all_canceled_count` Anzahl der stornierten Leads und Sales addiert.
`leads_open_provision` Provisionssumme der offenen Leads.
`leads_confirmed_provision` Provisionssumme der bestätigten Leads.
`leads_canceled_provision` Provisionssumme der stornierten Leads.
`sales_open_provision` Provisionssumme der offenen Sales.
`sales_confirmed_provision` Provisionssumme der bestätigten Sales.
`sales_canceled_provision` Provisionssumme der stornierten Sales.
`all_open_provision` Provisionssumme der offenen Leads und Sales addiert.
`all_confirmed_provision` Provisionssumme der bestätigten Leads und Sales addiert.
`all_canceled_provision` Provisionssumme der stornierten Leads und Sales addiert.
`views` Anzahl der Views.
`clicks` Anzahl der Klicks.
`epc` Die berechnete, durchschnittliche Einnahme pro Klick.
`ctr` Der Wert gibt an, wie viele User tatsächlich auf das Werbemittel klickten, nachdem sie es gesehen haben.
`leads_canceled_turnover` Gesamter Warenkorbwert der stornierten Leads.
`leads_open_turnover` Gesamter Warenkorbwert der offenen Leads.
`leads_confirmed_turnover` Gesamter Warenkorbwert der bestätigten Leads.
`sales_canceled_turnover` Gesamter Warenkorbwert stornierten Sales.
`sales_open_turnover` Gesamter Warenkorbwert der offenen Sales.
`sales_confirmed_turnover` Gesamter Warenkorbwert der bestätigten Sales.
# Touchpoints API - Dokumentation Die Touchpoints API ermöglicht den strukturierten Export und die Analyse von Touchpoints, die im Rahmen des Partnerprogramm-Systems erfasst wurden. Sie bietet detaillierte Einblicke in einzelne Touchpoints 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-customerjourney_orders**.csv**
WertBeschreibung
www.domain.deSystem-Partnerprogramm
ACCESS-TOKENAccess Token des Users
IDUser-ID
.csvArt des Downloads
--- ## Touchpoints-API Filterung Für die Touchpoints API können verschiedene Parameter als Filter verwendet werden. Nachfolgend eine Übersicht aller verfügbaren Parameter: ## Touchpoints-API Filter
**Parameter** **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
# Nachbuchungs API - Dokumentation Die Nachbuchung-API wird zum Aufruf der Nachbuchungen genutzt. Hierfür muss folgender Parameter an den API-Aufruf angehangen werden:
APIParameter
Nachbuchungen`get-bookingrequests`
**Beispiel:** `https://www.domain.de/api/ACCESS-TOKEN/publisher/ID/get-bookingrequests.csv` --- ## Nachbuchungs-API Filter Für die Bookingrequest-API gibt es zusätzliche Parameter, die abgefragt werden können. Nachfolgend eine Aufstellung aller Parameter:
ParameterWertBeschreibungBeispiel
`date_from`StartdatumDefinierung des Startdatums`date_from=01.01.1909`
`date_to`EnddatumDefinierung des Enddatums`date_to=19.12.1909`
`status`Status-WertAlle Nachbuchungen, welche unter dem entsprechenden Status hinterlegt sind. Mehrfachnennung möglich.`status=0`
> **Folgende Statusanfragen sind möglich:** > > - `canceled`: gibt abgelehnte Nachbuchungen aus > - `0`: gibt bestätigte Nachbuchungen aus, die in die Transaktionen überführt wurden > - `open`: gibt nicht bearbeitete Nachbuchungen aus --- ## Definition der Felder in der Nachbuchungs-API Die Spaltennamen der heruntergeladenen Nachbuchungen beinhalten folgende Parameter:
ParameterBeschreibung
`timestamp`Zeitpunkt der Nachbuchung.
`ordertoken`Bestellnummer der Nachbuchung.
`trigger_id`Trigger ID, welche der Nachbuchung zugeordnet wird.
`subid`Subid, welche bei der Transaktion übermittelt wurde.
`turnover`Provisionsrelevanter Bestellwert.
`status`Status der Nachbuchung.
`cancel_reason`Ablehnungsgrund der Nachbuchung.
# Werbemittel-API - Dokumentation Die Werbemittel API wird zum Aufruf der Werbemitteldaten genutzt. Hierfür muss folgender Parameter an den API-Aufruf angehangen werden:
APIParameter
Werbemittel**get-campaigns\_admedialist**
Beispiel: https://www.domain.de/api//ACCESS-TOKEN/publisher/ID/get-campaigns\_admedialist.csv ## Definition der Felder in der Werbemittel API Die Spaltennamen der heruntergeladenen Datei beinhalten folgende Parameter:
FeldnameBeschreibung
`id`Die ID des Werbemittels.
`title`Der Titel des Werbemittels.
`mediatype`Die Art des Werbemittels. Hier gibt es bspw. die Unterscheidung zwischen Text-Link, Banner oder einem Newsletter.
`status`Der Status des Werbemittels. (1 - aktiv)
`dimension`Die Abmessungen des Werbemittels. Dieser Wert ist nur bei Bannern relevant und zeigt die Größe des Werbemittels in Pixel.
`campaign_id`Die ID der Kampagne, der das Werbemittel angehört.
`campaign_title`Der Name der Kampagne, der das Werbemittel angehört.
`category_id`Die ID der Werbemittel-Kategorie, der das Werbemittel angehört.
`category_title`Der Name der Werbemittel-Kategorie, der das Werbemittel angehört.
`clicklink`Der Klicklink, welcher beim Klick auf das Werbemittel ausgeführt wird. Wird in der Statistik als "Klick" gezählt.
`viewlink`Der Viewlink, welcher beim Ansehen des Werbemittels ausgeführt wird. Wird in der Statistik als "View" gezählt.
`adcode`Der HTML-Code zur Implementierung des Werbemittels auf der Homepage.
`swfurl`--KEINE RELEVANZ--
`swfparameter`--KEINE RELEVANZ--
`valid_from`Gültigkeit des Werbemittels. Erst ab diesen Tag werden Klicks und Views gezählt.
`valid_until`Gültigkeit des Werbemittel. Bis zu diesem Tag werden Klicks und Views gezählt.
`vouchercode`Wenn ein Gutscheincode am Werbemittel hinterlegt ist, wird dieser hier ausgegeben.
`description`Die Beschreibung des Werbemittels.
`statistic`Angabe, ob das Werbemittel in der Statistik berücksichtigt wird.
`last_change`Zeitraum in der das Werbemittel zuletzt bearbeitet wurde.
# Produktfeed-API - Dokumentation Die Produktdaten können sich per API heruntergeladen werden. Hierfür wird einmalig der API Aufruf benötigt, welcher dem Frontend entnommen werden kann. Hierfür muss sich in dem entsprechenden System eingeloggt werden. Anschließend muss der Menüpunkt “Produktdaten” im Tab “Kampagnen” ausgewählt werden: [![image-20201015-102254.png](https://docs.easy-m.de/uploads/images/gallery/2026-03/scaled-1680-/image-20201015-102254.png)](https://docs.easy-m.de/uploads/images/gallery/2026-03/image-20201015-102254.png) Nachdem das entsprechende Feed ausgewählt wurde kann unter dem Menü “Standard Feed-Links” sich der API - Aufruf heruntergeladen werden. [![image-20201015-102550.png](https://docs.easy-m.de/uploads/images/gallery/2026-03/scaled-1680-/image-20201015-102550.png)](https://docs.easy-m.de/uploads/images/gallery/2026-03/image-20201015-102550.png) ## Verfügbare Trennzeichen Die Export-Datei kann in unterschiedlichen Trennzeichen ausgegeben werden. Hierfür muss dem API Aufruf ein zusätzlicher GET-Parameter hinzugefügt werden. Für das Trennzeichen lautet dieser “&separator=”
TrennzeichenParameter
Semicolon (;)semicolon
Komma (,)comma
Tabtab
Pipepipe
## Verfügbare Encapsulatoren Die Export-Datei kann mit unterschiedlichen Encapsulations ausgegeben werden. Hierfür muss dem API Aufruf ein zusätzlicher GET-Parameter hinzugefügt werden. Für das Trennzeichen lautet dieser “&encapsulation=”
EncapsulationParameter
Keinsnone
Anführungszeichen (“)quotes
Apostroph (`)apostroph
Apostroph (')apostrophe
## Filterung Es ist möglich den Aufruf nach bestimmten Inhalten einer Spalte zu filtern. Hierfür muss dem API Aufruf ein zusätzlicher GET-Parameter hinzugefügt werden. Für die Filterung lautet dieser “&filter\[SPALTENNAME\]=VALUE” **Beispiel:** https://DOMAIN/api//{API-TOKEN}/publisher/{PUBLISHER\_ID}/get-productdata.csv?feed\_id=FEED\_ID&campaign\_id=CAMPAIGN\_ID&project\_id=PROJECT\_ID&filter\[SPALTENNAME\]=VALUE ## Artikel ausschließen Artikel können im Feed über die Filterfunktion ausgeschlossen werden. Hierfür muss dem API Aufruf ein zusätzlicher GET-Parameter hinzugefügt werden. Für die Filterung lautet dieser “&filter\[SPALTENNAME\]= NOT VALUE”. Um mehrere Artikel auszuschließen müssen diese mit einem “OR” verbunden werden. **Beispiel:** https://DOMAIN/api//{API-TOKEN}/publisher/{PUBLISHER\_ID}/get-productdata.csv?feed\_id=FEED\_ID&campaign\_id=CAMPAIGN\_ID&project\_id=PROJECT\_ID&filter\[SPALTENNAME\]=NOT VALUE1 OR NOT VALUE2 # Kampagnen-API - Dokumentation Die Kampagnen API wird zum Aufruf der Kampagnendetails genutzt. Hierfür muss folgender Parameter an den API-Aufruf angehangen werden:
APIParameter
Werbemittel**get-campaigns\_list**
Beispiel: https://DOMAIN/api//ACCESS-TOKEN/publisher/ID/get-campaigns\_list.csv ## Definition der Felder in der Kampagnen API Die Spaltennamen der heruntergeladenen Datei beinhalten folgende Parameter:
FeldnameBeschreibung
`id`Die ID der Kampagne.
`title`Der Titel der Kampagne.
`logo_url`Die Logo URL der Kampagne.
`url`Die URL der Kampagne.
`trackinglink`Die Trackingurl der Kampagne.
`connection_status`Der aktuelle Status zur Kampagne - rejected: abgelehnt - no\_connection: keine Verbindung - connected: verbunden - canceled: storniert
## Abfragen weiterer Parameter Weitere Parameter können über das Hinzufügen des GET-Parameters “columns=” abgefragt werden. Hierunter fallen: - advertiser\_id - advertiser\_title # Wo ist der Access-Token zu finden? Der Access-Token wird zum Beispiel für den Abruf der Daten innerhalb der API benötigt. Der Access-Token wird für jeden Publisher separat generiert und ist somit einzigartig. Um den Access-Token zu erhalten, muss sich im entsprechenden System eingeloggt und über den Reiter “API” der Punkt “Daten API” angesteuert werden. Anschließend muss nach unten gescrollt werden, dort ist der Access-Token angegeben. [![image-20200227-100318.png](https://docs.easy-m.de/uploads/images/gallery/2026-03/scaled-1680-/image-20200227-100318.png)](https://docs.easy-m.de/uploads/images/gallery/2026-03/image-20200227-100318.png)