Addrevenue API-referentie

Addrevenue API-referentie (concept)

Onze REST API is ontwikkeld om te voldoen aan de behoeften van affiliates en adverteerders. Je genereert handmatig een levenslang API-token in onze gebruikersinterface. Dit Bearer-token wordt vervolgens bij elk verzoek als Authorization-header verzonden.

API-basis-URL

Alle eindpunten beginnen met de basis-URL:

https://addrevenue.io/api/v2

Gebruik altijd het HTTPS-protocol.

Authenticatie

Om een token te genereren, log je in op Addrevenue en ga je naar API-tokens, en dan naar Genereer een nieuw API-token. Hiermee wordt een uniek, levenslang API-token voor het ingelogde account aangemaakt.

Het token moet vervolgens als Bearer-token worden meegestuurd bij elk verzoek naar elk API-eindpunt.

Voorbeeld van een header:

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

Foutmeldingen

Het versturen van een lege, onjuist opgemaakte of ongeldige Bearer-token resulteert in een van deze HTTP-foutmeldingen:

Status Bericht Oorzaak
400 Authorization header not found De Authorization-header ontbreekt of is onjuist opgemaakt, bijvoorbeeld doordat het "Bearer"-voorvoegsel ontbreekt.
403 Invalid token De header is correct opgemaakt, maar het opgegeven API-token bestaat niet.
403 Inactive account De header is correct opgemaakt en het token bestaat, maar het behoort tot een account dat niet actief is.
403 (eindpuntspecifiek bericht) Het eindpunt is niet beschikbaar voor dit accounttype, bijvoorbeeld "Endpoint only available to affiliates".
404 Endpoint not found Het opgevraagde eindpunt bestaat niet.

Foutreacties zien er als volgt uit:

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

Reacties

Alle reacties zijn in JSON-formaat. Een succesvolle reactie bevat een results-array, een meta-object (aantal items en paginering), en een links-object (paginalinks):

{
    "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 is altijd een array, ook bij een enkel resultaat. meta.totalCount is het totale aantal overeenkomende items over alle pagina's, niet alleen de huidige pagina. Hieronder worden per eindpunt de velden vermeld die je kunt verwachten in elk item van results, en welke van die velden ook als filter gebruikt kunnen worden.

API-eindpunten

Aanvraagparameters

Je kunt de meeste eindpunten filteren door een queryparameter toe te voegen met dezelfde naam als een van de eigen velden van het item — bijvoorbeeld id, status, market, advertiserId, of channelId. Dit werkt alleen voor velden met een statische, opgeslagen waarde — in de tabel met responsvelden van elk eindpunt hieronder staat aangegeven welke velden op deze manier filterbaar zijn. Het werkt niet voor velden die berekend of afgeleid zijn van andere gegevens (bijvoorbeeld advertiserName, commissionShort, of epc), of voor geneste objecten en arrays (bijvoorbeeld markets of programs). Filteren op een niet-filterbaar veld resulteert in een foutmelding in plaats van dat het stilzwijgend wordt genegeerd.

Paginering

Gebruik limit (aantal items per pagina) en page (paginanummer, begint bij 1) om door de resultaten te bladeren, bijvoorbeeld /products?limit=50&page=2. offset wordt ook ondersteund als verouderd alternatief voor page.

Datumintervallen

Bij eindpunten waar dit van toepassing is, kun je filteren op een datuminterval met fromDate en/of toDate — samen, om een interval in te stellen, of afzonderlijk. Dit filtert op de aanmaakdatum van het record (het veld date, bij stats en trackingErrors) — bij elk eindpunt hieronder staat vermeld of dit wordt ondersteund.

Waar aangegeven, kun je ook updatedFromDate/updatedToDate gebruiken, die filteren op de datum waarop een item voor het laatst is bijgewerkt in plaats van wanneer het is aangemaakt.

Adverteerders

GET /advertisers

Toegankelijk voor

Alle accounttypes.

Affiliate-accounts zien alle actieve adverteerders — geef channelId op om de lijst te beperken tot adverteerders met een relatie (actief, in behandeling, of afgewezen) met dat kanaal. Adverteerder-accounts zien alleen hun eigen account. Agency-accounts zien de adverteerders die ze beheren.

Aanvraagparameters

Parameter Beschrijving
channelId Optioneel (alleen affiliates). Beperkt de resultaten tot adverteerders met een relatie met dit kanaal, en voegt relation/relationStatus toe aan elk resultaat.
expand Optioneel. Stel in op 1 om ook programs en landingPages op te nemen voor elke adverteerder.
fromDate, toDate Optioneel. Filter op aanmaakdatum.

Responsvelden

Veld Filterbaar Beschrijving
id Ja Adverteerder-ID.
name Ja Officiële bedrijfsnaam.
displayName Ja Openbare weergavenaam.
address, zipcode, city, country Ja Bedrijfsadres.
shortDescription — Korte marketingomschrijving.
categoryId Ja Categorie, bijv. insurance, foodDrink.
logoImageFilename — Absolute URL naar de logo-afbeelding.
url — Website van de adverteerder.
type — Altijd advertiser.
orgno, vatno Ja Organisatienummer en btw-nummer.
businessType — Type bedrijfsvorm.
autoApproveChannels Ja Of nieuwe kanaalrelaties automatisch worden goedgekeurd.
policyPaidAds/restrictionPaidAds Ja Beleid voor betaalde advertenties (allowed/notAllowed) en eventuele vrije-tekstbeperking.
policySocialMedia/restrictionSocialMedia Ja Beleid en beperking voor sociale media.
policyEmailMarketing/restrictionEmailMarketing Ja Beleid en beperking voor e-mailmarketing.
policyCouponRebate/restrictionCouponRebate Ja Beleid en beperking voor kortingscodes/rebate.
policyCashbackReward/restrictionCashbackReward Ja Beleid en beperking voor cashback/beloningen.
ecommercePlatform Ja bijv. shopify, customBuilt.
trackingMethod Ja Trackingintegratiemethode.
discountCodeTracking Ja Of tracking van kortingscodes is ingeschakeld.
approvedForPrepayouts Ja Of de adverteerder is goedgekeurd voor vroegtijdige uitbetalingen.
customTrackingParameters Ja Extra queryparameters die worden toegevoegd aan trackinglinks.
markets — Object met marktcode als sleutel. Elke markt heeft market, displayName, url, status, presentation (HTML), shortDescription, affiliatePageUrl, productFeedUrl, redirectUrl, endedDate, endedReason, activatedDate, productCount.
programs — Alleen bij channelId of expand. Commissieprogramma's — zie het Programs-eindpunt voor veldgegevens.
landingPages — Alleen bij expand.
relation/relationStatus — Alleen bij channelId. De relatie van jouw kanaal met deze adverteerder, en de status daarvan.

Banners

GET /banners

Toegankelijk voor

Alle accounttypes.

Affiliate-accounts zien bannergroepen voor alle actieve adverteerders — geef channelId op om ook een trackingcode te krijgen voor elke banner. Adverteerder- en agency-accounts zien alle bannergroepen voor hun eigen adverteerder(s), inclusief inactieve.

Aanvraagparameters

Parameter Beschrijving
channelId Optioneel (alleen affiliates). Indien opgegeven worden trackingcodes voor alle banners in de reactie opgenomen.
fromDate, toDate Optioneel. Filter op aanmaakdatum.

Responsvelden

Veld Filterbaar Beschrijving
id Ja Bannergroep-ID.
created Ja Wanneer de bannergroep is aangemaakt.
name, description Ja Naam en omschrijving van de bannergroep.
url Ja Optionele bestemmings-URL die de groep overschrijft.
advertiserId Ja De adverteerder waartoe deze groep behoort.
advertiserName — De weergavenaam van de adverteerder.
banners — Object met banner-ID als sleutel. Elke banner heeft id, created, width, height, filesize, format, filename, en, alleen bij channelId, trackingLink, imageLink, bannerHtmlCode (een kant-en-klaar <a><img></a>-fragment).

GET /brokenLinks

Toegankelijk voor

Alleen affiliates.

Responsvelden

Veld Filterbaar Beschrijving
id — Broken-link-ID.
url — De verbroken URL.
httpCode — De aangetroffen HTTP-statuscode, bijv. 404.
created — Wanneer de verbroken link is gedetecteerd.

Dit eindpunt bestrijkt altijd een vaste periode van 30 dagen en geeft de volledige resultatenset terug — aanvraagparameters (inclusief paginering en datumfilters) worden hier niet ondersteund.

Campagnes

GET /campaigns

Toegankelijk voor

Alle accounttypes.

Affiliate-accounts zien alle openbare actieve campagnes van alle adverteerders, plus eventuele kanaalexclusieve campagnes voor hun eigen kanalen — geef channelId op om te beperken tot adverteerders met een goedgekeurde relatie met dat kanaal, wat ook een trackingLink toevoegt aan elke campagne. Adverteerder- en agency-accounts zien alle campagnes voor hun eigen adverteerder(s) — actief en inactief, openbaar en kanaalexclusief.

Aanvraagparameters

Parameter Beschrijving
channelId Optioneel (alleen affiliates). Beperkt tot adverteerders met een goedgekeurde relatie met het kanaal, en voegt trackingLink toe aan elke campagne.
fromDate, toDate Optioneel. Filter op aanmaakdatum.

Responsvelden

Veld Filterbaar Beschrijving
id Ja Campagne-ID.
advertiserId Ja De adverteerder die de campagne uitvoert.
advertiserName, advertiserUrl — De weergavenaam en website van de adverteerder.
description Ja Campagneomschrijving.
discountCode Ja De kortingscode, als dit een couponcampagne is.
url Ja Landingspagina voor de campagne.
terms Ja Algemene voorwaarden.
validFrom, validTo Ja Geldigheidsperiode.
channelId Ja Alleen ingesteld voor kanaalexclusieve campagnes.
created Ja Wanneer de campagne is aangemaakt.
bannerGroupId Ja Gekoppelde bannergroep, indien van toepassing.
type — coupon of offer.
status — active of ended.
markets — Array van marktcodes waarop de campagne van toepassing is.
trackingLink — Alleen bij channelId. Jouw kanaal-gemarkeerde link naar de campagne-URL.

Kanalen

GET /channels

Toegankelijk voor

Alleen affiliates.

Aanvraagparameters

Parameter Beschrijving
fromDate, toDate Optioneel. Filter op aanmaakdatum.

Responsvelden

Veld Filterbaar Beschrijving
id Ja Kanaal-ID.
affiliateId Ja Jouw affiliate-account-ID.
name, url Ja Kanaalnaam en website-URL.
type Ja bijv. website.
visitors Ja Geschat aantal bezoekers.
status Ja Kanaalstatus.
created Ja Wanneer het kanaal is aangemaakt.
markets — Array van marktcodes, of null.

Events

GET /events

Toegankelijk voor

Alle accounttypes, beperkt tot je eigen adverteerder(s)/kanaal/kanalen zoals gebruikelijk — er is geen verschil in gedrag tussen accounttypes hierbuiten.

Aanvraagparameters

Parameter Beschrijving
fromDate, toDate Optioneel. Filter op aanmaakdatum — let op: dit filtert op created, niet op het aparte date-veld in de reactie.

Responsvelden

Veld Filterbaar Beschrijving
id Ja Event-ID.
date, created Ja Eventdatum en volledige tijdstempel.
advertiserId, channelId Ja De betrokken adverteerder en het betrokken kanaal.
type Ja Eventtype, bijv. Click. Dit verschilt per integratie van de adverteerder en is geen vaste lijst.
url Ja Pagina-URL waar het event plaatsvond.
value, currency Ja Orderwaarde en valuta, indien van toepassing.
orderId Ja Orderkenmerk van de adverteerder, indien van toepassing.
sandbox Ja Of dit een test-/sandbox-event was.
referrer Ja HTTP-referrer.
clickId Ja De click waaraan dit event is gekoppeld.
bannerId Ja De banner waarop is geklikt, indien van toepassing.
clickRef Ja Interne clickreferentie.
market Ja Marktcode.
redirectUrl Ja De landingspagina van de adverteerder waarnaar de click doorverwees.
affiliateUrl Ja De oorspronkelijke affiliate-pagina-URL.
affiliateGclid, wctid Ja Click-ID's van Google Ads / andere advertentieplatformen, indien aanwezig.
easylink Ja Of dit event via een Easylink tot stand kwam.
deviceType Ja desktop, mobile, tablet, of backend.
crossDeviceId Ja Cross-device-tracking-ID, indien beschikbaar.
subids Ja Je eigen sub-ID-parameters, indien meegestuurd.

Impressies

GET /impressions

Toegankelijk voor

Alle accounttypes, beperkt tot je eigen adverteerder(s)/kanaal/kanalen zoals gebruikelijk — er is geen verschil in gedrag tussen accounttypes hierbuiten.

Aanvraagparameters

Parameter Beschrijving
fromDate, toDate Optioneel. Filter op aanmaakdatum.

Responsvelden

Veld Filterbaar Beschrijving
id Ja Impressie-ID.
date, created Ja Impressiedatum en volledige tijdstempel.
advertiserId, channelId Ja De betrokken adverteerder en het betrokken kanaal.
url Ja Pagina-URL waar de impressie plaatsvond.
referrer Ja HTTP-referrer.
bannerId Ja De banner die werd getoond.
market Ja Marktcode.
deviceType Ja desktop, mobile, tablet, of backend.

Leads

POST /leads

Toegankelijk voor

Alleen affiliates. Momenteel wordt een beperkt aantal geïntegreerde adverteerders ondersteund.

Aanvraagbody

Veld Beschrijving
channelId Verplicht. Moet een van je eigen kanalen zijn.
advertiserId Verplicht. Moet een adverteerder zijn die is geïntegreerd met de Leads-API, en moet een actieve relatie hebben met het opgegeven kanaal.
(overige velden) Adverteerder-specifiek — worden doorgestuurd naar het lead-intakesysteem van de adverteerder.

De reactie wordt ongewijzigd teruggegeven vanuit het lead-intakesysteem van de adverteerder, in plaats van het standaard results/meta-formaat dat door de andere eindpunten wordt gebruikt.

Uitbetalingen

GET /payouts

Toegankelijk voor

Alleen affiliates.

Aanvraagparameters

Parameter Beschrijving
fromDate, toDate Optioneel. Filter op aanmaakdatum.

Responsvelden

Veld Filterbaar Beschrijving
id Ja Uitbetaling-ID.
affiliateId Ja Jouw affiliate-account-ID.
date, created Ja Uitbetalingsdatum en wanneer de uitbetaling is aangemaakt.
name Ja Naam van de begunstigde.
payoutDate Ja Wanneer de uitbetaling daadwerkelijk is gedaan.
address, zipcode, city, country Ja Adres van de begunstigde.
orgno, vatno Ja Organisatienummer en btw-nummer.
status Ja Uitbetalingsstatus.
sum, vat, total Ja Bedrag vóór btw, btw-bedrag, en totaal.
currency Ja Uitbetalingsvaluta.
payoutMethod Ja bijv. gebruikte bankoverschrijvingsmethode.
gigapayPayoutId Ja Referentie naar de Gigapay-uitbetaling, indien gebruikt.
gigapayPayout — Uitgebreide Gigapay-uitbetalingsgegevens, indien gebruikt.
currencyExchangeFee Ja Kosten voor valutaconversie, indien van toepassing.
taxRate Ja Toegepast belastingtarief.
bankCountry Ja Bankland, indien van toepassing.
manualAdjustment Ja Eventuele handmatige aanpassing op de uitbetaling.
noOfTransactions — Aantal opgenomen transacties.
kickbackRows, noOfKickbackRows — Kickback-regels, indien van toepassing.
language — Taal waarin het uitbetalingsdocument is gegenereerd.
accountNumber — Bankrekeningnummer van de begunstigde.
periodFrom, periodTo, periodText — De periode die deze uitbetaling dekt.
vatText — Btw-toelichting op het uitbetalingsdocument.
reverseCharge — Of btw-verlegging van toepassing is.
rows — Regels op het uitbetalingsdocument.
transactions — Object met transactie-ID als sleutel — dezelfde velden als het Transactions-eindpunt hieronder.

Productfeeds

GET /productfeeds

Toegankelijk voor

Alle accounttypes.

Affiliate-accounts zien feedmetadata voor elke adverteerder met een voltooide feed-ophaling — geef channelId op om dit te beperken tot adverteerders met een actieve relatie met dat kanaal, wat ook de feed-URL markeert voor de tracking van dat kanaal. Adverteerder- en agency-accounts zien altijd alleen de feeds van hun eigen adverteerder(s).

Aanvraagparameters

Parameter Beschrijving
channelId Optioneel. Zie hierboven.
detectedCurrency Optioneel. Filtert op feeds waarvan de automatisch gedetecteerde valuta overeenkomt.
detectedLanguage Optioneel. Filtert op feeds waarvan de automatisch gedetecteerde taal overeenkomt.

Datumfilters (fromDate/toDate) en paginering worden niet ondersteund op dit eindpunt — het geeft altijd de volledige resultatenset terug voor elke voltooide feed-ophaling.

Responsvelden

Veld Filterbaar Beschrijving
advertiserId Ja De adverteerder waartoe deze feed behoort.
advertiserName — De weergavenaam van de adverteerder.
market — Marktcode die de feed dekt.
sourceProductFeedUrl — De oorspronkelijke feed-URL van de adverteerder.
url/productFeedUrl — Alleen bij channelId. Jouw kanaal-gemarkeerde feed-URL.
started, finished Ja Wanneer het ophalen van de feed begon en eindigde. Dezelfde waarden als latestFetchDate/latestFetchFinished hieronder.
latestFetchDate, latestFetchFinished — Duplicaat, vriendelijkere namen voor started/finished.
checksum Ja Checksum van de opgehaalde feed, voor wijzigingsdetectie. Dezelfde waarde als latestFetchChecksum.
latestFetchChecksum — Duplicaat van checksum.
products — Aantal producten in de feed.
hasGtin — Aantal producten in de feed met een GTIN.
detectedCurrency, detectedLanguage Ja Automatisch gedetecteerde valuta en taal van de feed.

Producten

GET /products

Toegankelijk voor

Alle accounttypes.

Adverteerder- en agency-accounts zien hun eigen volledige catalogus, inclusief verborgen producten. Affiliate-accounts zien alleen zichtbare producten van adverteerders met een actieve markt.

Aanvraagparameters

Parameter Beschrijving
limit Optioneel. Aantal producten per pagina.
page Optioneel. Paginanummer.
channelId Optioneel (affiliates). Voegt een trackingLink toe aan elk product.

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

Datumfilters (fromDate/toDate) worden niet ondersteund op dit eindpunt.

Responsvelden

Veld Filterbaar Beschrijving
id Ja Intern product-ID.
advertiserId Ja De adverteerder die dit product verkoopt.
market Ja Marktcode.
title Ja Producttitel.
link Ja Productpagina-URL.
product_type, google_product_category Ja Categorievelden, volgens de Google Shopping-feedspecificatie.
image_link Ja Productafbeelding-URL.
condition Ja bijv. new.
availability Ja bijv. in_stock.
price, sale_price, currency Ja Normale prijs, aanbiedingsprijs, en valuta.
shipping, size, color, gender, material, age_group Ja Productattributen, indien beschikbaar.
min_handling_time, max_handling_time — Verwerkingstijd in dagen vóór verzending, alleen opgenomen als de adverteerder een terugvalwaarde heeft ingesteld voor zijn feed.
brand Ja Merknaam.
sku, mpn, gtin, product_id, item_group_id Ja Productidentificatoren.
hidden Ja Of het product verborgen is voor accounts die geen adverteerder zijn.
checksum Ja Checksum van de productgegevens, voor wijzigingsdetectie.
has_image_link Ja Of er een afbeeldings-URL beschikbaar is.
trackingLink — Alleen bij channelId. Jouw kanaal-gemarkeerde link naar de productpagina.

Programma's

GET /programs

Toegankelijk voor

Alle accounttypes.

Affiliate-accounts zien alleen actieve programma's. Adverteerder- en agency-accounts zien al hun programma's, ongeacht de status.

Aanvraagparameters

Parameter Beschrijving
fromDate, toDate Optioneel. Filter op aanmaakdatum.

Responsvelden

Veld Filterbaar Beschrijving
id, name Ja Programma-ID en -naam.
percent, amount, currency Ja Het commissiepercentage — percent voor variabel, amount/currency voor vast.
status Ja Programmastatus.
commissionType Ja variable of fixed.
conversionEventId Ja Het eventtype waarover dit programma commissie uitbetaalt.
commissionShort — Leesbare commissie, bijv. "15%" of "30 EUR".
commissionValue, commissionUnit — De numerieke commissiewaarde en de eenheid (% of valutacode).
commission — Uitgebreidere leesbare vorm, bijv. "Fixed (30 EUR)".
tieredCommissionModel, tieredCommissionStartDate Ja Getrapt commissiemodel en wanneer dit ingaat, indien getrapt.
channelId — Alleen ingesteld voor kanaalexclusieve programma's.
markets — Array van marktcodes waarop het programma van toepassing is.
tiers — Alleen voor getrapte programma's. Elke trap heeft transactions, value, amount/currency, commissionShort, transactionsText.
rules — Alleen wanneer voorwaardelijke commissieregels zijn ingesteld voor het programma.

Relaties

GET /relations

Toegankelijk voor

Alle accounttypes, beperkt tot je eigen relaties zoals gebruikelijk — er is geen verschil in gedrag tussen accounttypes hierbuiten.

Aanvraagparameters

Parameter Beschrijving
fromDate, toDate Optioneel. Filter op aanmaakdatum.
updatedFromDate, updatedToDate Optioneel. Filter op de datum waarop de relatie voor het laatst is bijgewerkt.

Responsvelden

Veld Filterbaar Beschrijving
id Ja Relatie-ID.
advertiserId Ja De adverteerderskant van de relatie.
advertiserName — De weergavenaam van de adverteerder.
channelId Ja De kanaalkant van de relatie.
channelName, channelType, channelCategory — Naam, type en categorie van het kanaal.
created, updated Ja Wanneer de relatie is aangemaakt en voor het laatst bijgewerkt.
status Ja Relatiestatus, bijv. active.
noticeDate, noticeDays Ja Opzegtermijn, indien de relatie wordt beëindigd.
endedDate, endedReason Ja Wanneer en waarom de relatie is beëindigd, indien van toepassing.
activatedDate Ja Wanneer de relatie actief is geworden.
trackingLink — De trackinglink van jouw kanaal voor deze adverteerder.
programs — Array van commissieprogramma's die beschikbaar zijn voor deze relatie — dezelfde velden als het Programs-eindpunt hierboven, plus individualCommission: true wanneer dit kanaal een eigen commissie-override heeft voor dat programma (in welk geval percent/amount de override al weerspiegelen).

Statistieken

GET /stats

Toegankelijk voor

Alle accounttypes. Adverteerder- en agency-accounts ontvangen daarnaast brokerage-fee-velden (brokerageFee, totalBrokerageFee, deniedBrokerageFee, denialRateBrokerageFee) in de reactie; deze worden niet opgenomen voor affiliate-accounts, omdat brokerage de marge van het platform is bovenop de commissie van de affiliate.

Aanvraagparameters

Parameter Beschrijving
groupBy Optioneel. Groepeert de reactie op een of meer dimensies: date, advertiser, channel, en/of program. Indien weggelaten, is de reactie één enkel geaggregeerd totaal. Combineer meerdere dimensies met een komma, bijv. groupBy=date,channel.
currency Optioneel. Een driecijferige valutacode om geldbedragen naar om te rekenen. Standaard de valuta van je account.
advertiserId, channelId, programId, market Optioneel. Beperk de aggregatie tot een specifieke adverteerder, kanaal, programma, en/of markt.
fromDate, toDate Optioneel. Filter op datum — dit eindpunt aggregeert op date, niet op created.

Responsvelden

Veld Beschrijving
advertiserId/advertiserName, channelId/channelName, programId/programName, affiliateId, market Alleen opgenomen voor de dimensies waarop je hebt gegroepeerd.
date/week/month/quarter/year Alleen opgenomen wanneer je hebt gegroepeerd op date.
clicks, impressions Aantal clicks en impressies.
transactions, transactionsInclClick Aantal transacties, met en zonder alleen-click-conversies.
sales Totale verkoopwaarde.
commission Totale commissie.
deniedTransactions, deniedCommission Aantal afgewezen transacties en commissie.
totalTransactions Totaal aantal transacties, inclusief afgewezen.
uniqueAdvertisersWithClicks/uniqueChannelsWithClicks/uniqueMarketsWithClicks Unieke aantallen binnen clicks in deze groep.
uniqueAdvertisersWithTransactions/uniqueChannelsWithTransactions/uniqueMarketsWithTransactions Unieke aantallen binnen transacties in deze groep.
uniqueMarketsWithClicksGroup De specifieke geziene marktcodes, als tekenreeks.
epc Verdiensten per click.
cr Conversiepercentage.
aov Gemiddelde orderwaarde.
currency Valuta van de geldbedragen.

Dit eindpunt geeft vooraf geaggregeerde statistieken terug in plaats van individuele records, dus de velden zijn niet op dezelfde veld-voor-veld-manier filterbaar als bij andere eindpunten — gebruik in plaats daarvan de aanvraagparameters hierboven.

Trackingfouten

GET /trackingErrors

Toegankelijk voor

Alle accounttypes, beperkt tot je eigen adverteerder(s)/kanaal/kanalen zoals gebruikelijk — er is geen verschil in gedrag tussen accounttypes hierbuiten.

Aanvraagparameters

Parameter Beschrijving
fromDate, toDate Optioneel. Filter op datum.

Responsvelden

Veld Filterbaar Beschrijving
id Ja Trackingfout-ID.
date Ja Wanneer de fout optrad.
channelId, advertiserId Ja Het betrokken kanaal en de betrokken adverteerder.
redirectUrl Ja De URL waarnaar de click probeerde door te verwijzen, indien van toepassing.
clickUrl Ja De trackingurl die werd aangeroepen.
message Ja Omschrijving van wat er misging.
referrer Ja HTTP-referrer.

Transacties

GET /transactions

Toegankelijk voor

Alle accounttypes. Adverteerder- en agency-accounts ontvangen daarnaast brokerage-fee-velden (brokerageMarkup, brokerageFee, deniedBrokerageFee, originalBrokerageFee) in de reactie; deze worden niet opgenomen voor affiliate-accounts.

Aanvraagparameters

Parameter Beschrijving
includeClicks Optioneel. Stel in op 1 om een array van de voorafgaande clicks bij elke transactie op te nemen.
includeProducts Optioneel. Stel in op 1 om de productregels van elke transactie op te nemen.
includeTransactionListStatus Optioneel. Stel in op 1 om de status van de uitbetalingsbatch waartoe elke transactie behoort op te nemen.
orderBy Optioneel. Sorteervolgorde voor de resultaten, bijv. created DESC.
fromDate, toDate Optioneel. Filter op aanmaakdatum.
updatedFromDate, updatedToDate Optioneel. Filter op de datum waarop de transactie voor het laatst is bijgewerkt.

Responsvelden

Veld Filterbaar Beschrijving
id Ja Transactie-ID.
date, created, updated Ja Transactiedatum, aanmaaktijdstempel, en tijdstempel van laatste update.
channelId, advertiserId Ja Het betrokken kanaal en de betrokken adverteerder.
channelName, advertiserName — Hun weergavenamen.
programId Ja Het toegepaste commissieprogramma.
programName Ja De naam van het commissieprogramma.
eventId Ja Het onderliggende trackingevent waaruit deze transactie is ontstaan.
commissionType Ja variable of fixed.
commissionPercent, commissionAmount Ja Het toegepaste tarief, overeenkomstig commissionType.
eventValue, currency Ja Orderwaarde en valuta.
conversionEventId Ja Het conversie-eventtype, bijv. Purchase.
status Ja new, approved, denied, delayed, of paidOut.
eventOrderId Ja Het eigen orderkenmerk van de adverteerder.
payoutId Ja De uitbetaling waarin deze transactie is opgenomen, zodra deze is uitbetaald.
transactionListId Ja De uitbetalingsbatch waartoe deze transactie behoort.
transactionListStatus — Alleen bij includeTransactionListStatus. Status van die uitbetalingsbatch.
clickRef, clickId Ja Referenties naar de oorspronkelijke click.
clickDate/clicks — Alleen bij includeClicks. De click(s) die aan deze transactie voorafgingen.
products — Alleen bij includeProducts. Productregels — elk met id, product_id, title, category, brand, quantity, price, total.
denyReason, denyReasonCategory, denyDate Ja Ingesteld wanneer de transactie is afgewezen.
market Ja Marktcode.
discountCodes Ja Gebruikte kortingscode(s) in de order, indien getrackt.
affiliateGclid, wctid Ja Click-ID's van Google Ads / andere advertentieplatformen, indien aanwezig.
untrackedSale Ja Of dit handmatig is toegevoegd als een niet-getrackte verkoop.
clickCount Ja Aantal clicks dat aan deze transactie is gekoppeld.
individualCommissionId Ja Ingesteld wanneer een kanaalspecifieke commissie-override is toegepast.
commissionSource Ja Waar de commissie vandaan komt, bijv. program, individualCommission.
delayedUntil Ja Datum waarop de transactie wordt vastgehouden, indien uitgesteld.
subids Ja Je eigen sub-ID-parameters, indien meegestuurd.
source Ja Herkomst van de transactie.
commission, commissionText — Berekend commissiebedrag en de leesbare vorm daarvan.
originalCommission — Commissie vóór eventuele aanpassingen.
currencies — Object met valutacode als sleutel, elk met rate, commission, eventValue, originalCommission — een naar valuta omgerekende weergave van dezelfde transactie.

De status van een transactie bijwerken

PATCH /transactions/status/{id}

Toegankelijk voor

Alleen adverteerders.

Werkt de status van een transactie bij. De reactie bevat de bijgewerkte transactie, in dezelfde vorm als hierboven.

Aanvraagbody

{ "status": "approved" }

Je kunt een transactie ook opzoeken via je eigen orderkenmerk in plaats van het Addrevenue-transactie-ID — laat {id} weg uit het pad en stuur { "orderId": "your-order-id", "status": "approved" }.

Toegestane status-waarden: new, approved, denied, delayed. Een transactie kan niet meer worden gewijzigd zodra deze is opgenomen in een uitbetalingsbatch die de status 'in behandeling' heeft verlaten.

Wijzigingslogboek

2026-09-02: De API-referentie uitgebreid met documentatie voor alle beschikbare eindpunten en hun volledige aanvraag- en responsparameters.

2026-08-04: GET /products gerepareerd, zodat andere accounts dan de adverteerder zelf geen producten meer zien van adverteerders met een inactieve markt.

2026-07-28: De aanvraagparameter includeProducts toegevoegd aan GET /transactions.

2026-07-16: Een bug opgelost in GET /relations waarbij soms kanaalexclusieve programma's werden getoond die niet van toepassing waren op het opgegeven kanaal.

2026-06-25: De nauwkeurigheid van detectedCurrency/detectedLanguage in GET /productfeeds gerepareerd. GET /products bevat nu min_handling_time/max_handling_time wanneer de adverteerder een terugvalwaarde heeft ingesteld.

2026-06-02: De links.prev-paginalink gerepareerd, die voorheen onterecht kon verschijnen op de eerste pagina van de resultaten.

2026-05-15: De velden detectedCurrency en detectedLanguage toegevoegd aan de reactie van GET /productfeeds.

2026-04-28: Het eindpunt GET /brokenLinks toegevoegd.

2026-04-07: Het veld landingPages toegevoegd aan de reactie van GET /advertisers (beschikbaar met expand=1).

2026-03-06: Het veld conversionEventId toegevoegd aan de reactie van GET /programs.

2026-01-25: De aanvraagparameters updatedFromDate/updatedToDate gerepareerd, die voorheen niet werden toegepast door een interne naamgevingsfout.

2024-09-18: De namen van de pagineringsparameters gewijzigd van productsPerPage en selectedPage naar limit en offset.

2022-05-12: Nieuw eindpunt /payouts toegevoegd waarmee affiliates al hun uitbetalingen kunnen ophalen.

2022-04-28: Nieuw eindpunt /productfeeds toegevoegd waarmee affiliates een lijst van alle productfeed-URL's kunnen ophalen.

2022-04-27: Nieuw eindpunt /relations toegevoegd om je relaties tussen kanalen en adverteerders weer te geven.

2022-04-22: De mogelijkheid toegevoegd om /stats op meerdere dimensies te groeperen.

2022-04-21: channelId toegevoegd als aanvraagparameter voor het eindpunt /advertisers, om de reactie te beperken tot adverteerders met relaties met het opgegeven kanaal.

2022-04-20: Het eindpunt /stats toegevoegd om geaggregeerde statistieken op te halen.

2022-04-19: De mogelijkheid toegevoegd om de reacties van bepaalde eindpunten zoals transactions en events te beperken met de queryparameters fromDate en/of toDate.

2022-03-22: Bij het versturen van channelId naar het eindpunt /campaigns worden nu alleen campagnes getoond van adverteerders met een goedgekeurde relatie met het kanaal.

2022-03-19: De aanvraagparameter includeClicks toegevoegd aan het eindpunt /transactions, om alle voorafgaande clicks op te nemen in een array.

2022-03-18: trackingLink toegevoegd aan de reactie van het eindpunt /campaigns, indien de parameter channelId is opgegeven.

2022-03-18: advertiserName toegevoegd aan de reactie van het eindpunt /campaigns.

2022-03-18: advertiserName toegevoegd aan de reactie van het eindpunt /banners.

×

Account aanmaken

Kies het accounttype dat het beste bij je profiel past.