Advertiser API - Dokumentation

Basket API – Dokumentation
Transaktions API - Dokumentation
Statistik 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/advertiser/ID/get-orders_baskets.csv

Wert	Beschreibung
www.domain.de	System-Partnerprogramm
ACCESS-TOKEN	Access Token des Users
ID	User-ID
.csv	Art 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:

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 Basket-API

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

Feldname	Beschreibung
`id`	Eindeutige ID des Basket-Items
`orderid`	Interne ID der zugehörigen Transaktion
`timestamp`	Zeitpunkt der Transaktion
`ordertoken`	Bestellnummer der Transaktion
`trigger_id`	ID des Triggers, der der Transaktion zugeordnet ist
`is_basket`	Gibt an, ob es sich um ein Basket-Item handelt (`true` / `false`)
`basket_item_id`	Eindeutige ID des Basket-Items
`category`	Übergebene Kategorie des Shops
`productid`	ID des Produkts im Shop
`productname`	Name des Produkts im Shop
`amount`	Anzahl der gekauften Produkte
`price`	Stückpreis des Produkts
`original_price`	Ursprünglicher Stückpreis vor Änderungen
`status`	Status des Basket-Items
`total`	Gesamtpreis (Anzahl × Preis)
`commission`	Provision, die der Publisher für das Basket-Item erhält
`currency_rate`	Umrechnungsrate bei Fremdwährung
`currency`	Währung der Transaktion
`is_attributed`	Gibt an, ob eine Attribution vorliegt (`true` / `false`)
`attribution`	Art der Attribution pro Basket-Item
`attributed_price`	Attribuierter Preis pro Basket-Item
`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/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

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/advertiser/ID/get-statistic_daily.csv

Wert	Beschreibung
www.domain.de	System-Partnerprogramm
ACCESS-TOKEN	Access Token des Users
ID	User-ID
get-statistic_{Statistik-Art}	Art der Statistik (z.B. Tagesbasiert, etc.)
.csv	Art 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-Art	Parameter
Statistik nach Tag	`get-statistic_daily`
Statistik nach Advertiser	`get-statistic_advertiser`
Statistik nach Kampagnen	`get-statistic_campaign`
Statistik nach Werbemittel	`get-statistic_media`
Statistik nach Publisher	`get-statistic_publisher`
Statistik nach Projekt	`get-statistic_project`
Statistik nach SubID	`get-statistic_subid`
Statistik nach Referrer	`get-statistic_referrer`
Statistik nach Channel	`get-statistic_channel`
Statistik nach Provisionsgruppe	`get-statistic_provisionsgroup`
Statistik nach Trigger	`get-statistic_trigger`
Statistik nach Journey	`get-statistic_journey`
Statistik nach A/B-Test	`get-statistic_abtest`
Statistik nach Gerätetyp	`get-statistic_devicetype`
Statistik nach Gerät	`get-statistic_device`
Statistik nach Browser	`get-statistic_browser`
Statistik nach Betriebssystem	`get-statistic_os`
Statistik nach Land	`get-statistic_geocountry`
Manuelle Statistik	`get-statistic_manualstatistics`

Parameter	Wert / Beispiel	Beschreibung
`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` = ausgezahlt	Filtert nach Auszahlungsstatus
`condition[dynamicdate]`	`currentmonth` = aktueller Monat `lastmonth` = vorheriger Monat `currentweek` = aktuelle Woche `last10d` = letzte 10 Tage	Dynamische Zeiträume
`condition[l:publisher]`	`1234,5678`	Filtert nach Publisher-IDs
`condition[project_id]`	`12345`	Filtert nach Projekt-IDs
`condition[bruttodata]`	`true`	Gibt Bruttozahlen zurück (z. B. Klicks/Views)
`condition[l:mandant]`	`1`	Filtert nach Mandanten-IDs
`condition[l:advertiser]`	`2,3`	Filtert nach Advertiser-IDs
`condition[l:campaigns]`	`1,3`	Filtert nach Kampagnen-IDs

Aufschlüsselung nach weiteren Kriterien (Dynamische-Statistik)

Die Statistik kann zusätzlich nach weiteren Kriterien aufgeschlüsselt (segmentiert) werden.
Hierzu wird der Parameter condition[l:criterions] verwendet.

Parameter	Wert	Beschreibung	Beispiel
`condition[l:criterions]`	`day`	Aufschlüsselung nach Tag	`condition[l:criterions]=day`
	`publisher`	Aufschlüsselung nach Publisher	`condition[l:criterions]=publisher`
	`media`	Aufschlüsselung nach Werbemittel	`condition[l:criterions]=media`
	`advertiser`	Aufschlüsselung nach Advertiser	`condition[l:criterions]=advertiser`
	`campaign`	Aufschlüsselung nach Kampagnenname	`condition[l:criterions]=campaign`
	`campaign_id`	Aufschlüsselung nach Kampagnen-ID	`condition[l:criterions]=campaign_id`
Kombination	z. B. `day,publisher,media`	Mehrdimensionale Aufschlüsselung	`condition[l:criterions]=day,publisher,media`

Hinzufügen von KPIs

Über den Parameter condition[l:additional_parameters] können zusätzliche Key Performance Indicators (KPIs) zur Statistik hinzugefügt werden.

Parameter	Wert	Beschreibung	Beispiel
`condition[l:additional_parameters]`	`all`	Fügt alle verfügbaren KPIs hinzu	`condition[l:additional_parameters]=all`

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.