Addrevenue API-Referenz

Addrevenue API-Referenz (Entwurf)

Unsere REST-API wurde entwickelt, um die Anforderungen von Affiliates und Werbetreibenden zu unterstützen. Sie generieren manuell ein lebenslanges API-Token in unserer Benutzeroberfläche. Dieses Bearer-Token wird dann bei jeder Anfrage als Authorization-Header gesendet.

API-Basis-URL

Alle Endpunkte beginnen mit der Basis-URL:

https://addrevenue.io/api/v2

Verwenden Sie immer das HTTPS-Protokoll.

Authentifizierung

Um ein Token zu generieren, melden Sie sich bei Addrevenue an und gehen Sie zu API-Token, dann Neues API-Token generieren. Dadurch wird ein einmaliges, lebenslanges API-Token für das angemeldete Konto erstellt.

Das Token sollte dann als Bearer-Token in allen Anfragen an jeden API-Endpunkt gesendet werden.

Beispiel eines Headers:

Authorization: Bearer 1892cd44-c59c-42bf-9f1d-a5316ea695cc
Content-type: application/json

Fehler

Das Senden eines leeren, fehlerhaften oder ungültigen Bearer-Tokens führt zu einem dieser HTTP-Fehler:

Status Nachricht Ursache
400 Authorization header not found Der Authorization-Header fehlt oder ist fehlerhaft formatiert, zum Beispiel fehlt das Präfix "Bearer".
403 Invalid token Der Header ist korrekt formatiert, aber das angegebene API-Token existiert nicht.
403 Inactive account Der Header ist korrekt formatiert und das Token existiert, aber es gehört zu einem Konto, das nicht aktiv ist.
403 (endpunktspezifische Nachricht) Der Endpunkt ist für diesen Kontotyp nicht verfügbar, zum Beispiel "Endpoint only available to affiliates".
404 Endpoint not found Der angeforderte Endpunkt existiert nicht.

Fehlerantworten sehen so aus:

{
    "error": {
        "message": "Invalid token"
    }
}

Antworten

Alle Antworten liegen im JSON-Format vor. Eine erfolgreiche Antwort enthält ein results-Array, ein meta-Objekt (Anzahl der Elemente und Pagination) und ein links-Objekt (Pagination-Links):

{
    "results": [
        { "id": 1000, "description": "Sample campaign A" },
        { "id": 1001, "description": "Sample campaign B" }
    ],
    "meta": {
        "count": 2,
        "totalCount": 27,
        "page": 1,
        "perPage": 2,
        "totalPages": 14,
        "hasPrevPage": false,
        "hasNextPage": true
    },
    "links": {
        "self": "https://addrevenue.io/api/v2/campaigns?limit=2",
        "next": "https://addrevenue.io/api/v2/campaigns?limit=2&page=2"
    }
}

results ist immer ein Array, auch bei nur einem Ergebnis. meta.totalCount ist die Gesamtanzahl der übereinstimmenden Elemente über alle Seiten hinweg, nicht nur der aktuellen Seite. Nachfolgend listet jeder Endpunkt die Felder auf, die Sie in jedem Element von results erwarten können, sowie welche dieser Felder auch als Filter verwendet werden können.

API-Endpunkte

Anfrageparameter

Sie können die meisten Endpunkte filtern, indem Sie einen Query-String-Parameter mit demselben Namen wie eines der eigenen Felder des Elements hinzufügen — zum Beispiel id, status, market, advertiserId oder channelId. Dies funktioniert nur bei Feldern, die einen statischen, gespeicherten Wert enthalten — die Tabelle "Antwortfelder" jedes Endpunkts weiter unten kennzeichnet, welche Felder auf diese Weise filterbar sind. Es funktioniert nicht bei Feldern, die berechnet oder aus anderen Daten abgeleitet werden (zum Beispiel advertiserName, commissionShort oder epc), oder bei verschachtelten Objekten und Arrays (zum Beispiel markets oder programs). Das Filtern nach einem nicht filterbaren Feld führt zu einem Fehler, anstatt stillschweigend ignoriert zu werden.

Pagination

Verwenden Sie limit (Elemente pro Seite) und page (1-basierte Seitenzahl), um durch die Ergebnisse zu blättern, zum Beispiel /products?limit=50&page=2. offset wird ebenfalls als veraltete Alternative zu page unterstützt.

Datumsintervalle

Für Endpunkte, bei denen dies zutrifft, können Sie mit fromDate und/oder toDate nach einem Datumsintervall filtern — entweder zusammen, um einen Zeitraum festzulegen, oder einzeln. Dies filtert nach dem Erstellungsdatum des Datensatzes (bei stats und trackingErrors nach dessen date-Feld) — jeder Endpunkt unten gibt an, ob dies unterstützt wird.

Wo angegeben, können Sie auch updatedFromDate/updatedToDate verwenden, die nach dem Datum filtern, an dem ein Element zuletzt aktualisiert wurde, statt nach dem Erstellungsdatum.

Werbetreibende

GET /advertisers

Zugänglich für

Alle Kontotypen.

Affiliate-Konten sehen alle aktiven Werbetreibenden — übergeben Sie channelId, um die Liste auf Werbetreibende mit einer Beziehung (aktiv, ausstehend oder abgelehnt) zu diesem Kanal einzuschränken. Advertiser-Konten sehen nur ihr eigenes Konto. Agency-Konten sehen die Werbetreibenden, die sie verwalten.

Anfrageparameter

Parameter Beschreibung
channelId Optional (nur Affiliates). Beschränkt die Ergebnisse auf Werbetreibende mit einer Beziehung zu diesem Kanal und fügt jedem Ergebnis relation/relationStatus hinzu.
expand Optional. Auf 1 setzen, um für jeden Werbetreibenden auch programs und landingPages einzuschließen.
fromDate, toDate Optional. Nach Erstellungsdatum filtern.

Antwortfelder

Feld Filterbar Beschreibung
id Ja ID des Werbetreibenden.
name Ja Rechtlicher Firmenname.
displayName Ja Öffentlicher Anzeigename.
address, zipcode, city, country Ja Firmenadresse.
shortDescription — Kurze Marketingbeschreibung.
categoryId Ja Kategorie, z. B. insurance, foodDrink.
logoImageFilename — Absolute URL zum Logo-Bild.
url — Website des Werbetreibenden.
type — Immer advertiser.
orgno, vatno Ja Organisationsnummer und USt-IdNr.
businessType — Art der Unternehmensform.
autoApproveChannels Ja Ob neue Kanalbeziehungen automatisch genehmigt werden.
policyPaidAds/restrictionPaidAds Ja Richtlinie für bezahlte Anzeigen (allowed/notAllowed) und etwaige Freitext-Einschränkung.
policySocialMedia/restrictionSocialMedia Ja Richtlinie für Social Media und Einschränkung.
policyEmailMarketing/restrictionEmailMarketing Ja Richtlinie für E-Mail-Marketing und Einschränkung.
policyCouponRebate/restrictionCouponRebate Ja Richtlinie für Gutscheine/Rabatte und Einschränkung.
policyCashbackReward/restrictionCashbackReward Ja Richtlinie für Cashback/Prämien und Einschränkung.
ecommercePlatform Ja z. B. shopify, customBuilt.
trackingMethod Ja Tracking-Integrationsmethode.
discountCodeTracking Ja Ob das Tracking von Rabattcodes aktiviert ist.
approvedForPrepayouts Ja Ob der Werbetreibende für vorzeitige Auszahlungen (Pre-Payouts) freigegeben ist.
customTrackingParameters Ja Zusätzliche Query-Parameter, die an Tracking-Links angehängt werden.
markets — Objekt, geschlüsselt nach Marktcode. Jeder Markt hat market, displayName, url, status, presentation (HTML), shortDescription, affiliatePageUrl, productFeedUrl, redirectUrl, endedDate, endedReason, activatedDate, productCount.
programs — Nur mit channelId oder expand. Provisionsprogramme — Feldangaben siehe Endpunkt "Programme".
landingPages — Nur mit expand.
relation/relationStatus — Nur mit channelId. Die Beziehung Ihres Kanals zu diesem Werbetreibenden und ihr Status.

Banner

GET /banners

Zugänglich für

Alle Kontotypen.

Affiliate-Konten sehen Bannergruppen für alle aktiven Werbetreibenden — übergeben Sie channelId, um zusätzlich einen Tracking-Code für jedes Banner zu erhalten. Advertiser- und Agency-Konten sehen alle Bannergruppen für ihre eigenen Werbetreibenden, einschließlich inaktiver.

Anfrageparameter

Parameter Beschreibung
channelId Optional (nur Affiliates). Falls angegeben, werden Tracking-Codes für alle Banner in die Antwort aufgenommen.
fromDate, toDate Optional. Nach Erstellungsdatum filtern.

Antwortfelder

Feld Filterbar Beschreibung
id Ja ID der Bannergruppe.
created Ja Wann die Bannergruppe erstellt wurde.
name, description Ja Name und Beschreibung der Bannergruppe.
url Ja Optionale Ziel-URL, die die Gruppen-URL überschreibt.
advertiserId Ja Der Werbetreibende, zu dem diese Gruppe gehört.
advertiserName — Der Anzeigename des Werbetreibenden.
banners — Objekt, geschlüsselt nach Banner-ID. Jedes Banner hat id, created, width, height, filesize, format, filename sowie, nur mit channelId, trackingLink, imageLink, bannerHtmlCode (ein fertiges <a><img></a>-Snippet zum Einbetten).

GET /brokenLinks

Zugänglich für

Nur Affiliate.

Antwortfelder

Feld Filterbar Beschreibung
id — ID des defekten Links.
url — Die defekte URL.
httpCode — Der aufgetretene HTTP-Statuscode, z. B. 404.
created — Wann der defekte Link erkannt wurde.

Dieser Endpunkt deckt immer ein festes 30-Tage-Fenster ab und liefert die vollständige Ergebnismenge — Anfrageparameter (einschließlich Pagination und Datumsfilter) werden hier nicht unterstützt.

Kampagnen

GET /campaigns

Zugänglich für

Alle Kontotypen.

Affiliate-Konten sehen alle öffentlichen aktiven Kampagnen aller Werbetreibenden sowie alle kanalexklusiven Kampagnen für ihre eigenen Kanäle — übergeben Sie channelId, um nur Kampagnen von Werbetreibenden mit einer genehmigten Beziehung zu diesem Kanal zu erhalten, wodurch auch jeder Kampagne ein trackingLink hinzugefügt wird. Advertiser- und Agency-Konten sehen alle Kampagnen ihrer eigenen Werbetreibenden — aktive und inaktive, öffentliche und kanalexklusive.

Anfrageparameter

Parameter Beschreibung
channelId Optional (nur Affiliates). Beschränkt auf Werbetreibende mit einer genehmigten Beziehung zum Kanal und fügt jeder Kampagne trackingLink hinzu.
fromDate, toDate Optional. Nach Erstellungsdatum filtern.

Antwortfelder

Feld Filterbar Beschreibung
id Ja Kampagnen-ID.
advertiserId Ja Der Werbetreibende, der die Kampagne durchführt.
advertiserName, advertiserUrl — Anzeigename und Website des Werbetreibenden.
description Ja Kampagnenbeschreibung.
discountCode Ja Der Rabattcode, falls es sich um eine Gutschein-Kampagne handelt.
url Ja Landingpage der Kampagne.
terms Ja Allgemeine Geschäftsbedingungen.
validFrom, validTo Ja Gültigkeitszeitraum.
channelId Ja Nur bei kanalexklusiven Kampagnen gesetzt.
created Ja Wann die Kampagne erstellt wurde.
bannerGroupId Ja Verknüpfte Bannergruppe, falls vorhanden.
type — coupon oder offer.
status — active oder ended.
markets — Array der Marktcodes, für die die Kampagne gilt.
trackingLink — Nur mit channelId. Ihr kanalspezifischer Link zur Kampagnen-URL.

Kanäle

GET /channels

Zugänglich für

Nur Affiliate.

Anfrageparameter

Parameter Beschreibung
fromDate, toDate Optional. Nach Erstellungsdatum filtern.

Antwortfelder

Feld Filterbar Beschreibung
id Ja Kanal-ID.
affiliateId Ja Ihre Affiliate-Konto-ID.
name, url Ja Kanalname und Website-URL.
type Ja z. B. website.
visitors Ja Geschätztes Besucheraufkommen.
status Ja Kanalstatus.
created Ja Wann der Kanal erstellt wurde.
markets — Array der Marktcodes, oder null.

Events

GET /events

Zugänglich für

Alle Kontotypen, wie üblich auf Ihre eigenen Werbetreibenden/Kanäle beschränkt — darüber hinaus gibt es keinen Unterschied im Verhalten zwischen den Kontotypen.

Anfrageparameter

Parameter Beschreibung
fromDate, toDate Optional. Nach Erstellungsdatum filtern — Hinweis: Dies filtert nach created, nicht nach dem separaten Feld date in der Antwort.

Antwortfelder

Feld Filterbar Beschreibung
id Ja Event-ID.
date, created Ja Event-Datum und vollständiger Zeitstempel.
advertiserId, channelId Ja Der beteiligte Werbetreibende und Kanal.
type Ja Event-Typ, z. B. Click. Variiert je nach Integration des Werbetreibenden und ist keine feste Liste.
url Ja Seiten-URL, auf der das Event stattfand.
value, currency Ja Bestellwert und Währung, falls zutreffend.
orderId Ja Bestell-ID des Werbetreibenden, falls zutreffend.
sandbox Ja Ob es sich um ein Test-/Sandbox-Event handelte.
referrer Ja HTTP-Referrer.
clickId Ja Der Klick, mit dem dieses Event verknüpft ist.
bannerId Ja Das angeklickte Banner, falls vorhanden.
clickRef Ja Interne Klick-Referenz.
market Ja Marktcode.
redirectUrl Ja Die Landingpage des Werbetreibenden, zu der der Klick weitergeleitet wurde.
affiliateUrl Ja Die ursprüngliche Affiliate-Seiten-URL.
affiliateGclid, wctid Ja Google-Ads- bzw. andere Werbeplattform-Klick-IDs, falls vorhanden.
easylink Ja Ob dieses Event über einen Easylink erfolgte.
deviceType Ja desktop, mobile, tablet oder backend.
crossDeviceId Ja Geräteübergreifende Tracking-ID, falls verfügbar.
subids Ja Ihre eigenen Sub-ID-Parameter, falls gesendet.

Impressionen

GET /impressions

Zugänglich für

Alle Kontotypen, wie üblich auf Ihre eigenen Werbetreibenden/Kanäle beschränkt — darüber hinaus gibt es keinen Unterschied im Verhalten zwischen den Kontotypen.

Anfrageparameter

Parameter Beschreibung
fromDate, toDate Optional. Nach Erstellungsdatum filtern.

Antwortfelder

Feld Filterbar Beschreibung
id Ja Impressions-ID.
date, created Ja Impressions-Datum und vollständiger Zeitstempel.
advertiserId, channelId Ja Der beteiligte Werbetreibende und Kanal.
url Ja Seiten-URL, auf der die Impression stattfand.
referrer Ja HTTP-Referrer.
bannerId Ja Das angezeigte Banner.
market Ja Marktcode.
deviceType Ja desktop, mobile, tablet oder backend.

Leads

POST /leads

Zugänglich für

Nur Affiliate. Derzeit wird eine begrenzte Anzahl integrierter Werbetreibender unterstützt.

Request Body

Feld Beschreibung
channelId Erforderlich. Muss einer Ihrer eigenen Kanäle sein.
advertiserId Erforderlich. Muss ein Werbetreibender sein, der in die Leads-API integriert ist, und eine aktive Beziehung zum angegebenen Kanal haben.
(weitere Felder) Spezifisch für den Werbetreibenden — werden unverändert an das Lead-Erfassungssystem des Werbetreibenden weitergegeben.

Die Antwort wird unverändert vom Lead-Erfassungssystem des Werbetreibenden zurückgegeben, statt im Standardformat results/meta, das die anderen Endpunkte verwenden.

Auszahlungen

GET /payouts

Zugänglich für

Nur Affiliate.

Anfrageparameter

Parameter Beschreibung
fromDate, toDate Optional. Nach Erstellungsdatum filtern.

Antwortfelder

Feld Filterbar Beschreibung
id Ja Auszahlungs-ID.
affiliateId Ja Ihre Affiliate-Konto-ID.
date, created Ja Auszahlungsdatum und Erstellungszeitpunkt der Auszahlung.
name Ja Name des Zahlungsempfängers.
payoutDate Ja Wann die Auszahlung tatsächlich erfolgte.
address, zipcode, city, country Ja Adresse des Zahlungsempfängers.
orgno, vatno Ja Organisationsnummer und USt-IdNr.
status Ja Auszahlungsstatus.
sum, vat, total Ja Betrag vor USt, USt-Betrag und Gesamtbetrag.
currency Ja Auszahlungswährung.
payoutMethod Ja z. B. verwendete Überweisungsmethode.
gigapayPayoutId Ja Referenz zur Gigapay-Auszahlung, falls verwendet.
gigapayPayout — Erweiterte Details zur Gigapay-Auszahlung, falls verwendet.
currencyExchangeFee Ja Gebühr für Währungsumrechnung, falls zutreffend.
taxRate Ja Angewendeter Steuersatz.
bankCountry Ja Bankland, falls zutreffend.
manualAdjustment Ja Manuelle Anpassung der Auszahlung, falls vorhanden.
noOfTransactions — Anzahl der enthaltenen Transaktionen.
kickbackRows, noOfKickbackRows — Kickback-Positionen, falls vorhanden.
language — Sprache, in der das Auszahlungsdokument erstellt wurde.
accountNumber — Bankkontonummer des Zahlungsempfängers.
periodFrom, periodTo, periodText — Der Zeitraum, den diese Auszahlung abdeckt.
vatText — USt-Hinweistext auf dem Auszahlungsdokument.
reverseCharge — Ob das Reverse-Charge-Verfahren gilt.
rows — Positionen auf dem Auszahlungsdokument.
transactions — Objekt, geschlüsselt nach Transaktions-ID — gleiche Felder wie beim Endpunkt "Transaktionen" weiter unten.

Produktfeeds

GET /productfeeds

Zugänglich für

Alle Kontotypen.

Affiliate-Konten sehen Feed-Metadaten für jeden Werbetreibenden mit einem abgeschlossenen Feed-Abruf — übergeben Sie channelId, um dies auf Werbetreibende mit einer aktiven Beziehung zu diesem Kanal zu beschränken, wodurch die Feed-URL zusätzlich für das Tracking dieses Kanals markiert wird. Advertiser- und Agency-Konten sehen immer nur die Feeds ihrer eigenen Werbetreibenden.

Anfrageparameter

Parameter Beschreibung
channelId Optional. Siehe oben.
detectedCurrency Optional. Filtert auf Feeds, bei denen die automatisch erkannte Währung übereinstimmt.
detectedLanguage Optional. Filtert auf Feeds, bei denen die automatisch erkannte Sprache übereinstimmt.

Datumsfilter (fromDate/toDate) und Pagination werden bei diesem Endpunkt nicht unterstützt — er liefert immer die vollständige Ergebnismenge für jeden abgeschlossenen Feed-Abruf.

Antwortfelder

Feld Filterbar Beschreibung
advertiserId Ja Der Werbetreibende, zu dem dieser Feed gehört.
advertiserName — Der Anzeigename des Werbetreibenden.
market — Marktcode, den der Feed abdeckt.
sourceProductFeedUrl — Die ursprüngliche Feed-URL des Werbetreibenden.
url/productFeedUrl — Nur mit channelId. Ihre kanalspezifisch markierte Feed-URL.
started, finished Ja Wann der Feed-Abruf begann und endete. Gleiche Werte wie latestFetchDate/latestFetchFinished unten.
latestFetchDate, latestFetchFinished — Doppelte, benutzerfreundlichere Namen für started/finished.
checksum Ja Prüfsumme des abgerufenen Feeds zur Änderungserkennung. Gleicher Wert wie latestFetchChecksum.
latestFetchChecksum — Duplikat von checksum.
products — Anzahl der Produkte im Feed.
hasGtin — Anzahl der Produkte im Feed, die eine GTIN enthalten.
detectedCurrency, detectedLanguage Ja Automatisch erkannte Währung und Sprache des Feeds.

Produkte

GET /products

Zugänglich für

Alle Kontotypen.

Advertiser- und Agency-Konten sehen ihren gesamten eigenen Katalog, einschließlich versteckter Produkte. Affiliate-Konten sehen nur sichtbare Produkte von Werbetreibenden mit einem aktiven Markt.

Anfrageparameter

Parameter Beschreibung
limit Optional. Anzahl der Produkte pro Seite.
page Optional. Seitenzahl.
channelId Optional (Affiliates). Fügt jedem Produkt einen trackingLink hinzu.

Beispiel: /products?limit=50&page=2

Datumsfilter (fromDate/toDate) werden bei diesem Endpunkt nicht unterstützt.

Antwortfelder

Feld Filterbar Beschreibung
id Ja Interne Produkt-ID.
advertiserId Ja Der Werbetreibende, der dieses Produkt verkauft.
market Ja Marktcode.
title Ja Produkttitel.
link Ja Produktseiten-URL.
product_type, google_product_category Ja Kategoriefelder gemäß der Google-Shopping-Feed-Spezifikation.
image_link Ja Produktbild-URL.
condition Ja z. B. new.
availability Ja z. B. in_stock.
price, sale_price, currency Ja Regulärer Preis, Verkaufspreis und Währung.
shipping, size, color, gender, material, age_group Ja Produktattribute, sofern verfügbar.
min_handling_time, max_handling_time — Bearbeitungszeit in Tagen vor Versand, nur enthalten, wenn der Werbetreibende einen Fallback-Wert für seinen Feed konfiguriert hat.
brand Ja Markenname.
sku, mpn, gtin, product_id, item_group_id Ja Produktkennungen.
hidden Ja Ob das Produkt für Nicht-Advertiser-Konten verborgen ist.
checksum Ja Prüfsumme der Produktdaten zur Änderungserkennung.
has_image_link Ja Ob eine Bild-URL verfügbar ist.
trackingLink — Nur mit channelId. Ihr kanalspezifischer Link zur Produktseite.

Programme

GET /programs

Zugänglich für

Alle Kontotypen.

Affiliate-Konten sehen nur aktive Programme. Advertiser- und Agency-Konten sehen alle ihre Programme, unabhängig vom Status.

Anfrageparameter

Parameter Beschreibung
fromDate, toDate Optional. Nach Erstellungsdatum filtern.

Antwortfelder

Feld Filterbar Beschreibung
id, name Ja Programm-ID und -Name.
percent, amount, currency Ja Der Provisionssatz — percent bei variabler, amount/currency bei fester Provision.
status Ja Programmstatus.
commissionType Ja variable oder fixed.
conversionEventId Ja Der Event-Typ, für den dieses Programm Provision zahlt.
commissionShort — Provision in Klartext, z. B. "15%" oder "30 EUR".
commissionValue, commissionUnit — Der numerische Provisionswert und seine Einheit (% oder Währungscode).
commission — Längere Klartext-Form, z. B. "Fixed (30 EUR)".
tieredCommissionModel, tieredCommissionStartDate Ja Staffelungsmodell und ab wann es gilt, falls gestaffelt.
channelId — Nur bei kanalexklusiven Programmen gesetzt.
markets — Array der Marktcodes, für die das Programm gilt.
tiers — Nur bei gestaffelten Programmen. Jede Stufe hat transactions, value, amount/currency, commissionShort, transactionsText.
rules — Nur wenn für das Programm bedingte Provisionsregeln konfiguriert sind.

Beziehungen

GET /relations

Zugänglich für

Alle Kontotypen, wie üblich auf Ihre eigenen Beziehungen beschränkt — darüber hinaus gibt es keinen Unterschied im Verhalten zwischen den Kontotypen.

Anfrageparameter

Parameter Beschreibung
fromDate, toDate Optional. Nach Erstellungsdatum filtern.
updatedFromDate, updatedToDate Optional. Nach dem Datum filtern, an dem die Beziehung zuletzt aktualisiert wurde.

Antwortfelder

Feld Filterbar Beschreibung
id Ja Beziehungs-ID.
advertiserId Ja Die Werbetreibenden-Seite der Beziehung.
advertiserName — Der Anzeigename des Werbetreibenden.
channelId Ja Die Kanal-Seite der Beziehung.
channelName, channelType, channelCategory — Name, Typ und Kategorie des Kanals.
created, updated Ja Wann die Beziehung erstellt und zuletzt aktualisiert wurde.
status Ja Beziehungsstatus, z. B. active.
noticeDate, noticeDays Ja Kündigungsfrist, falls die Beziehung gekündigt wird.
endedDate, endedReason Ja Wann und warum die Beziehung endete, falls zutreffend.
activatedDate Ja Wann die Beziehung aktiv wurde.
trackingLink — Der Tracking-Link Ihres Kanals für diesen Werbetreibenden.
programs — Array der auf dieser Beziehung verfügbaren Provisionsprogramme — gleiche Felder wie beim Endpunkt "Programme" oben, plus individualCommission: true, wenn dieser Kanal eine eigene Provisions-Sonderregelung für dieses Programm hat (in diesem Fall spiegeln percent/amount bereits die Sonderregelung wider).

Statistiken

GET /stats

Zugänglich für

Alle Kontotypen. Advertiser- und Agency-Konten erhalten zusätzlich Brokerage-Fee-Felder (brokerageFee, totalBrokerageFee, deniedBrokerageFee, denialRateBrokerageFee) in der Antwort; diese sind für Affiliate-Konten nicht enthalten, da die Brokerage-Fee der Aufschlag der Plattform auf die Provision des Affiliates ist.

Anfrageparameter

Parameter Beschreibung
groupBy Optional. Aggregiert die Antwort nach einer oder mehreren Dimensionen: date, advertiser, channel und/oder program. Falls weggelassen, ist die Antwort ein einziger aggregierter Gesamtwert. Kombinieren Sie mehrere Dimensionen mit einem Komma, z. B. groupBy=date,channel.
currency Optional. Ein 3-stelliger Währungscode, in den monetäre Felder umgerechnet werden. Standardmäßig die Währung Ihres Kontos.
advertiserId, channelId, programId, market Optional. Beschränkt die Aggregation auf einen bestimmten Werbetreibenden, Kanal, Programm und/oder Markt.
fromDate, toDate Optional. Nach Datum filtern — dieser Endpunkt aggregiert nach date, nicht nach created.

Antwortfelder

Feld Beschreibung
advertiserId/advertiserName, channelId/channelName, programId/programName, affiliateId, market Nur für die Dimensionen enthalten, nach denen gruppiert wurde.
date/week/month/quarter/year Nur enthalten, wenn nach date gruppiert wurde.
clicks, impressions Klick- und Impressionszahlen.
transactions, transactionsInclClick Transaktionszahlen, mit und ohne reine Klick-Conversions.
sales Gesamtumsatz.
commission Gesamtprovision.
deniedTransactions, deniedCommission Anzahl abgelehnter Transaktionen und deren Provision.
totalTransactions Gesamtanzahl der Transaktionen einschließlich abgelehnter.
uniqueAdvertisersWithClicks/uniqueChannelsWithClicks/uniqueMarketsWithClicks Eindeutige Anzahlen über die Klicks in dieser Gruppe.
uniqueAdvertisersWithTransactions/uniqueChannelsWithTransactions/uniqueMarketsWithTransactions Eindeutige Anzahlen über die Transaktionen in dieser Gruppe.
uniqueMarketsWithClicksGroup Die konkreten gesehenen Marktcodes, als Zeichenkette.
epc Earnings per Click.
cr Conversion-Rate.
aov Durchschnittlicher Bestellwert.
currency Währung der monetären Felder.

Dieser Endpunkt liefert vorab aggregierte Statistiken statt einzelner Datensätze, daher sind seine Felder nicht auf die gleiche feldweise Art filterbar wie bei anderen Endpunkten — verwenden Sie stattdessen die oben genannten Anfrageparameter.

Tracking-Fehler

GET /trackingErrors

Zugänglich für

Alle Kontotypen, wie üblich auf Ihre eigenen Werbetreibenden/Kanäle beschränkt — darüber hinaus gibt es keinen Unterschied im Verhalten zwischen den Kontotypen.

Anfrageparameter

Parameter Beschreibung
fromDate, toDate Optional. Nach Datum filtern.

Antwortfelder

Feld Filterbar Beschreibung
id Ja ID des Tracking-Fehlers.
date Ja Wann der Fehler auftrat.
channelId, advertiserId Ja Der beteiligte Kanal und Werbetreibende.
redirectUrl Ja Die URL, zu der der Klick weiterleiten sollte, falls vorhanden.
clickUrl Ja Die aufgerufene Tracking-URL.
message Ja Beschreibung, was schiefgelaufen ist.
referrer Ja HTTP-Referrer.

Transaktionen

GET /transactions

Zugänglich für

Alle Kontotypen. Advertiser- und Agency-Konten erhalten zusätzlich Brokerage-Fee-Felder (brokerageMarkup, brokerageFee, deniedBrokerageFee, originalBrokerageFee) in der Antwort; diese sind für Affiliate-Konten nicht enthalten.

Anfrageparameter

Parameter Beschreibung
includeClicks Optional. Auf 1 setzen, um ein Array der Klicks einzuschließen, die jeder Transaktion vorausgingen.
includeProducts Optional. Auf 1 setzen, um die Produktpositionen jeder Transaktion einzuschließen.
includeTransactionListStatus Optional. Auf 1 setzen, um den Status des Auszahlungsstapels einzuschließen, zu dem jede Transaktion gehört.
orderBy Optional. Sortierreihenfolge der Ergebnisse, z. B. created DESC.
fromDate, toDate Optional. Nach Erstellungsdatum filtern.
updatedFromDate, updatedToDate Optional. Nach dem Datum filtern, an dem die Transaktion zuletzt aktualisiert wurde.

Antwortfelder

Feld Filterbar Beschreibung
id Ja Transaktions-ID.
date, created, updated Ja Transaktionsdatum, Erstellungszeitstempel und Zeitstempel der letzten Aktualisierung.
channelId, advertiserId Ja Der beteiligte Kanal und Werbetreibende.
channelName, advertiserName — Deren Anzeigenamen.
programId Ja Das angewendete Provisionsprogramm.
programName Ja Der Name des Provisionsprogramms.
eventId Ja Das zugrunde liegende Tracking-Event, aus dem diese Transaktion erstellt wurde.
commissionType Ja variable oder fixed.
commissionPercent, commissionAmount Ja Der angewendete Satz, passend zu commissionType.
eventValue, currency Ja Bestellwert und Währung.
conversionEventId Ja Der Conversion-Event-Typ, z. B. Purchase.
status Ja new, approved, denied, delayed oder paidOut.
eventOrderId Ja Die eigene Bestell-ID des Werbetreibenden.
payoutId Ja Die Auszahlung, in der diese Transaktion enthalten war, sobald ausgezahlt.
transactionListId Ja Der Auszahlungsstapel, zu dem diese Transaktion gehört.
transactionListStatus — Nur mit includeTransactionListStatus. Status dieses Auszahlungsstapels.
clickRef, clickId Ja Referenzen zum ursprünglichen Klick.
clickDate/clicks — Nur mit includeClicks. Die Klicks, die dieser Transaktion vorausgingen.
products — Nur mit includeProducts. Produktpositionen — jeweils mit id, product_id, title, category, brand, quantity, price, total.
denyReason, denyReasonCategory, denyDate Ja Gesetzt, wenn die Transaktion abgelehnt wurde.
market Ja Marktcode.
discountCodes Ja Verwendete(r) Rabattcode(s) in der Bestellung, falls getrackt.
affiliateGclid, wctid Ja Google-Ads- bzw. andere Werbeplattform-Klick-IDs, falls vorhanden.
untrackedSale Ja Ob dies manuell als ungetrackter Verkauf hinzugefügt wurde.
clickCount Ja Anzahl der mit dieser Transaktion verknüpften Klicks.
individualCommissionId Ja Gesetzt, wenn eine kanalspezifische Provisions-Sonderregelung angewendet wurde.
commissionSource Ja Woher die Provision stammt, z. B. program, individualCommission.
delayedUntil Ja Datum, bis zu dem die Transaktion zurückgehalten wird, falls verzögert.
subids Ja Ihre eigenen Sub-ID-Parameter, falls gesendet.
source Ja Herkunft der Transaktion.
commission, commissionText — Berechneter Provisionsbetrag und dessen Klartext-Form.
originalCommission — Provision vor etwaigen Anpassungen.
currencies — Objekt, geschlüsselt nach Währungscode, jeweils mit rate, commission, eventValue, originalCommission — eine währungsumgerechnete Ansicht derselben Transaktion.

Statusaktualisierung einer Transaktion

PATCH /transactions/status/{id}

Zugänglich für

Nur Advertiser.

Aktualisiert den Status einer Transaktion. Die Antwort enthält die aktualisierte Transaktion, im gleichen Format wie oben.

Request Body

{ "status": "approved" }

Sie können eine Transaktion auch anhand Ihrer eigenen Bestell-ID statt ihrer Addrevenue-Transaktions-ID nachschlagen — lassen Sie {id} im Pfad weg und senden Sie { "orderId": "your-order-id", "status": "approved" }.

Zulässige status-Werte: new, approved, denied, delayed. Eine Transaktion kann nicht mehr geändert werden, sobald sie in einen Auszahlungsstapel aufgenommen wurde, der den ausstehenden Status verlassen hat.

Änderungsprotokoll

2026-09-02: Die API-Referenz um die Dokumentation aller verfügbaren Endpunkte sowie deren vollständige Anfrage- und Antwortparameter erweitert.

2026-08-04: GET /products korrigiert, sodass andere Konten als der Werbetreibende selbst keine Produkte von Werbetreibenden mit inaktivem Markt mehr sehen.

2026-07-28: Den Anfrageparameter includeProducts zu GET /transactions hinzugefügt.

2026-07-16: Einen Fehler in GET /relations behoben, bei dem gelegentlich kanalexklusive Programme angezeigt wurden, die für den angegebenen Kanal nicht galten.

2026-06-25: Die Genauigkeit von detectedCurrency/detectedLanguage bei GET /productfeeds korrigiert. GET /products enthält nun min_handling_time/max_handling_time, wenn der Werbetreibende einen Fallback-Wert konfiguriert hat.

2026-06-02: Den Pagination-Link links.prev korrigiert, der fälschlicherweise auf der ersten Ergebnisseite erscheinen konnte.

2026-05-15: Die Felder detectedCurrency und detectedLanguage zur Antwort von GET /productfeeds hinzugefügt.

2026-04-28: Den Endpunkt GET /brokenLinks hinzugefügt.

2026-04-07: Das Feld landingPages zur Antwort von GET /advertisers hinzugefügt (verfügbar mit expand=1).

2026-03-06: Das Feld conversionEventId zur Antwort von GET /programs hinzugefügt.

2026-01-25: Die Anfrageparameter updatedFromDate/updatedToDate korrigiert, die zuvor aufgrund einer internen Namensabweichung nicht angewendet wurden.

2024-09-18: Die Namen der Pagination-Parameter von productsPerPage und selectedPage auf limit und offset geändert.

2022-05-12: Den neuen Endpunkt /payouts hinzugefügt, damit Affiliates alle Auszahlungen abrufen können.

2022-04-28: Den neuen Endpunkt /productfeeds hinzugefügt, damit Affiliates eine Liste aller Produktfeed-URLs abrufen können.

2022-04-27: Den neuen Endpunkt /relations hinzugefügt, um Ihre Beziehungen zwischen Kanälen und Werbetreibenden aufzulisten.

2022-04-22: Die Möglichkeit hinzugefügt, /stats nach mehreren Dimensionen zu gruppieren.

2022-04-21: channelId als Anfrageparameter zum Endpunkt /advertisers hinzugefügt, um die Antwort auf Werbetreibende mit Beziehungen zum angegebenen Kanal zu beschränken.

2022-04-20: Den Endpunkt /stats hinzugefügt, um aggregierte Statistiken abzurufen.

2022-04-19: Die Möglichkeit hinzugefügt, die Antworten bestimmter Endpunkte wie transactions und events mittels der Query-String-Parameter fromDate und/oder toDate einzuschränken.

2022-03-22: Beim Senden von channelId an den Endpunkt /campaigns werden nun nur noch Kampagnen von Werbetreibenden mit einer genehmigten Beziehung zum Kanal angezeigt.

2022-03-19: Den Anfrageparameter includeClicks zum Endpunkt /transactions hinzugefügt, um alle vorausgehenden Klicks in einem Array einzuschließen.

2022-03-18: trackingLink in der Antwort des Endpunkts /campaigns hinzugefügt, sofern der Parameter channelId angegeben wird.

2022-03-18: advertiserName in der Antwort des Endpunkts /campaigns hinzugefügt.

2022-03-18: advertiserName in der Antwort des Endpunkts /banners hinzugefügt.

×

Benutzerkonto erstellen

Wählen Sie den Kontotyp, der am besten zu Ihrem Profil passt