Addrevenue API-reference

Addrevenue API-reference (kladde)

Vores REST API er udviklet til at understøtte behovene hos affiliates og annoncører. Du genererer et livstids API-token manuelt i vores brugergrænseflade. Dette Bearer-token sendes derefter som en Authorization-header i hver anmodning.

API-basis-URL

Alle endpoints starter med basis-URL'en:

https://addrevenue.io/api/v2

Brug altid HTTPS-protokollen.

Autentificering

For at generere et token skal du logge ind på Addrevenue og gå til API-tokens og derefter klikke på Generer et nyt API-token. Dette opretter et unikt livstids-API-token for den loggede konto.

Tokenet skal derefter sendes som et Bearer-token i alle anmodninger til ethvert API-slutpunkt.

Eksempel på en header:

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

Fejl

Afsendelse af et tomt, misdannet eller ugyldigt Bearer-token vil resultere i en af disse HTTP-fejl:

Status Meddelelse Årsag
400 Autorisationsheader ikke fundet Autorisationsheaderen mangler eller er forkert udformet, for eksempel uden præfikset "Bearer".
403 Ugyldig token Headeren er korrekt formateret, men den angivne API-token findes ikke.
403 Inaktiv konto Headeren er korrekt formateret, og tokenet findes, men det tilhører en konto, der ikke er aktiv.
403 (slutpunktsspecifik (besked) Endpunktet er ikke tilgængeligt for denne kontotype, for eksempel "Endpunkt kun tilgængeligt for affilierede".
404 Endpunkt ikke fundet Det anmodede slutpunkt findes ikke.

Fejlsvar ser sådan ud:

 
{ 
"error": { 
"message": "Ugyldig token" 
} 
}

Svar

Alle svar leveres i JSON-format. Et vellykket svar indeholder et resultater-array, et meta-objekt (antal poster og paginering) og et links-objekt (pagineringslinks):

 
{ 
"resultater": [ 
{ "id": 1000, "beskrivelse": "Eksempelkampagne A" }, 
{ "id": 1001, "beskrivelse": "Eksempelkampagne B" } 
], 
"meta": { 
"count": 2, 
"totalCount": 27, 
"side": 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" 
} 
}

resultater er altid et array, selv for et enkelt resultat. meta.totalCount er det samlede antal matchende poster på tværs af alle sider, ikke kun den aktuelle side. Nedenfor viser hvert slutpunkt, hvilke felter du kan forvente i hvert resultater-objekt, og hvilke af disse felter der også kan bruges som filtre.

API-slutpunkter

Anmodningsparametre

Du kan filtrere de fleste slutpunkter ved at tilføje en forespørgselsstrengparameter med samme navn som et af objektets egne felter — for eksempel id, status, marked, annoncørId eller kanalId. Dette fungerer kun for felter, der har en statisk, lagret værdi — det respektive slutpunkts svarfelttabel nedenfor fremhæver, hvilke felter der kan filtreres på denne måde. Det fungerer ikke for felter, der er beregnet eller afledt af andre data (f.eks. annoncørNavn, commissionShort eller epc), eller for indlejrede objekter og arrays (f.eks. markeder eller programmer). Filtrering på et felt, der ikke kan filtreres på, returnerer en fejl i stedet for at blive ignoreret lydløst.

Paginering

Brug limit (antal poster pr. side) og page (sidetal, 1-baseret) til at rulle gennem resultater, for eksempel /products?limit=50&page=2. offset understøttes også som et ældre alternativ til page.

Datointerval

For slutpunkter, hvor det er relevant, kan du filtrere på et datointerval ved hjælp af fromDate og/eller toDate — enten sammen, for at indstille et interval eller individuelt. Dette filtrerer på postens oprettelsesdato (dens date-felt, for stats og trackingErrors) — det respektive slutpunkt nedenfor angiver, om dette understøttes.

Hvor det er angivet, kan du også bruge updatedFromDate/updatedToDate, som filtrerer på den dato, hvor en post sidst blev opdateret, i stedet for hvornår den blev oprettet.

Annoncører

GET /advertisers

Tilgængelig for

Alle kontotyper.

Affilierede konti ser alle aktive annoncører — indsend channelId for at begrænse listen til annoncører med en relation (aktiv, afventende eller afvist) til den pågældende kanal. Annoncørkonti ser kun deres egen konto. Bureaukonti ser de annoncører, de administrerer.

Anmodningsparametre

Parameter Beskrivelse
kanal-ID Valgfri (kun affilierede). Begrænser resultater til annoncører med en relation til denne kanal og tilføjer relation/relationStatus til hvert resultat.
udvid Valgfri. Indstil til 1 for også at inkludere programmer og landingsider for hver annoncør.
fradato, tildato Valgfrit. Filtrer efter oprettelsesdato.

Svarfelt

Felt Filtrerbar Beskrivelse
id Ja Annoncør-ID.
navn Ja Juridisk virksomhedsnavn.
displayName Ja Offentligt visningsnavn.
adresse, postnummer, by, land Ja Virksomhedsadresse.
kort beskrivelse — Kort marketingbeskrivelse.
kategori-id Ja Kategori, f.eks. forsikring, madDrikke.
logoBilledeFilnavn — Absolut URL til logobilledet.
url — Annoncørens hjemmeside.
type — Altid annoncør.
orgno, vandno Ja Organisationsnummer og momsnummer.
virksomhedstype — Type af virksomhedsform.
autoApproveChannels Ja Hvis nye kanalrelationer automatisk godkendes.
politikBetalte annoncer/begrænsningBetalte annoncer Ja Politik for betalt annoncering (tilladt/ikke tilladt) og enhver gratis tekstbegrænsninger.
politikSocialeMedier/begrænsningSocialeMedier Ja Politik og begrænsning for sociale medier.
politikE-mailmarkedsføring/begrænsningE-mailmarkedsføring Ja Politik og begrænsning for e-mailmarkedsføring.
politikKuponrabat/begrænsningKuponrabat Ja Politik og begrænsning for rabatkoder.
politikCashbackReward/begrænsningCashbackReward Ja Cashback/belønningspolitik og begrænsning.
e-handelsplatform Ja F.eks. shopify, customBuilt.
trackingMethod Ja Sporingsintegrationsmetode.
discountCodeTracking Ja Hvis rabatkodesporing er aktiveret.
godkendtTilForudbetalinger Ja Hvis annoncøren er godkendt til forudbetalinger.
customTrackingParameters Ja Ekstra forespørgselsparametre tilføjet til sporingslinks.
markeder — Objekt indekseret efter markedskode. Hvert marked har marked, displayName, url, status, præsentation (HTML), shortDescription, affiliatePageUrl, productFeedUrl, redirectUrl, redirectUr. endedReason, activatedDate, productCount.
programmer — Kun med channelId eller expand. Kommissionér programmer — se Programs-slutpunktet for feltdetaljer.
landingsider — Kun med udvid.
relation/relationStatus — Kun med kanal-id. Din kanals forhold til denne annoncør og dens status.

Bannere

HENT /banners

Tilgængelig for

Alle kontotyper.

Affilierede konti ser bannergrupper for alle aktive annoncører — send channelId for også at få en sporingskode for hvert banner. Annoncør- og bureaukonti ser alle bannergrupper for deres egne annoncører, inklusive inaktive.

Anmodningsparametre

Parameter Beskrivelse
kanal-ID Valgfri (kun for affilierede). Hvis angivet, inkluderes sporingskoder for alle bannere i svaret.
fromDate, toDate Valgfri. Filtrer efter oprettelsesdato.

Svarfelt

Felt Filtrerbar Beskrivelse
id Ja Bannergruppe-ID.
oprettet Ja Da bannergruppen blev oprettet.
navn, beskrivelse Ja Navn og beskrivelse af bannergruppen.
url Ja Enhver destinations-URL, der tilsidesætter gruppens standard.
annoncør-ID Ja Den annoncør, som denne gruppe tilhører.
annoncørnavn — Annoncørens viste navn.
bannere — Objekt indekseret på banner-ID. Hvert banner har id, oprettet, bredde, højde, filstørrelse, format, filnavn og, kun med kanal-ID, trackingLink, billedeLink, bannerHtmlCode (et færdiglavet -snippet til indlejring).

HENT /brokenLinks

Tilgængelig for

Affiliate kun.

Svarfelt

Felt Filtrerbar Beskrivelse
id — ID'et på det brudte link.
url — Den brudte URL.
httpCode — Den fundne HTTP-statuskode, f.eks. 404.
oprettet — Da det ødelagte link blev opdaget.

Dette slutpunkt dækker altid et fast 30-dages vindue og returnerer hele resultatsættet — anmodningsparametre (inklusive paginering og datofiltre) understøttes ikke her.

Kampagner

GET /campaigns

Tilgængelig for

Alle kontotyper.

Affilierede konti ser alle offentlige, aktive kampagner for alle annoncører plus eventuelle kanaleksklusive kampagner for deres egne kanaler — send videre channelId for at begrænse til annoncører med en godkendt relation til den pågældende kanal, hvilket også tilføjer et trackingLink for hver kampagne. Annoncør- og bureaukonti ser alle kampagner for deres egen(e) annoncør(er) - aktive og inaktive, offentlige og kanaleksklusive.

Anmodningsparametre

Parameter Beskrivelse
channelId Valgfri (kun for affilierede). Begrænser til annoncører med en godkendt relation til kanalen og tilføjer trackingLink til hver kampagne.
fromDate, toDate Valgfri. Filtrer efter oprettelsesdato.

Svarfelt

Felt Filtrerbar Beskrivelse
id Ja Kampagne-ID.
annoncør-ID Ja Annoncøren, der kører kampagnen.
annoncørnavn, annoncørURL — Annoncørens viste navn og websted.
beskrivelse Ja Kampagnebeskrivelse.
rabatkode Ja Rabatkode, hvis dette er en kuponkampagne.
url Ja Landingsside for kampagnen.
vilkår Ja Betingelsestekst.
gyldigFra, gyldigTil Ja Gyldighedsperiode.
kanal-ID Ja Indstilles kun til kanaleksklusive kampagner.
oprettet Ja Hvornår kampagnen blev oprettet.
bannerGroupId Ja Tilknyttet bannergruppe, hvis relevant.
type — kupon eller tilbud.
status — aktiv eller afsluttet.
markeder — Område af markedskoder, som kampagnen gælder for til.
sporingslink — Kun med kanal-id. Dit kanal-brandede link til kampagnens URL.

Kanaler

GET /channels

Tilgængelig for

Kun affilierede.

Anmodningsparametre

Parameter Beskrivelse
fromDate, toDate Valgfri. Filtrer efter oprettelsesdato.

Svarfelt

.

Felt Filtrerbar Beskrivelse
id Ja Kanal-ID.
affiliateId Ja Dit affiliate-konto-ID.
navn, url Ja Kanalnavn og hjemmeside-URL.
type Ja F.eks. hjemmeside.
besøgende Ja Anslået besøgsvolumen.
status Ja Kanalstatus.
oprettet Ja Hvornår kanalen blev oprettet.
markeder — Matrix af markedskoder, eller null

Begivenheder

GET /events

Tilgængelig for

Alle kontotyper, begrænset til dine egne annoncører/kanaler som sædvanlig — der er ingen adfærdsmæssig forskel mellem kontotyper ud over det.

Anmodningsparametre

Valgfrit. Filtrer efter oprettelsesdato — bemærk, at dette filtrerer efter oprettet, ikke efter det separate dato-felt i svaret.

Parameter Beskrivelse
fromDate, toDate

Svarfelter

Felter Filtrerbar Beskrivelse
id Ja Hændelses-ID.
dato, oprettet Ja Begivenhedsdato og fuldt tidsstempel.
annoncør-ID, kanal-ID Ja Den involverede annoncør og kanal.
type Ja Begivenhedstype, f.eks. Klik. Dette varierer afhængigt af annoncørintegrationen og er ikke en fast liste.
url Ja Side-URL, hvor hændelsen fandt sted.
værdi, valuta Ja Ordreværdi og valuta, hvis relevant.
ordre-id Ja Annoncørens eget ordre-id, hvis relevant.
sandkasse Ja Hvis dette var en test-/sandbox-begivenhed.
referrer Ja HTTP-referrer.
klik-id Ja Det klik, som denne begivenhed er knyttet til.
banner-id Ja Det banner, der blev klikket på, hvis der er et.
klikreference Ja Intern klikreference.
marked Ja Markedskode.
redirectUrl Ja Annoncørens landingsside, som klikket blev omdirigeret til.
affiliateUrl Ja Den oprindelige URL til den affilierede side.
affiliateGclid, wctid Ja Klik-ID'er fra Google Ads / andre annonceplatforme, hvis tilgængelige.
easylink Ja Hvis denne hændelse kom via et Easylink.
enhedstype Ja desktop, mobil, tablet eller backend.
crossDeviceId Ja Sporings-ID på tværs af enheder, hvis tilgængelige.
subids Ja Dine egne sub-ID-parametre, hvis de sendes.

Visninger

HENT /impressions

Tilgængelig for

Alle kontotyper, begrænset til dine egne annoncører/kanaler som sædvanlig — der er ingen adfærdsmæssig forskel mellem kontotyper ud over det.

Anmodningsparametre

Parameter Beskrivelse
fradato, tildato Valgfrit. Filtrer efter oprettelsesdato.

Svarfelt

.

Felt Filtrerbar Beskrivelse
id Ja Vis ID.
dato, oprettet Ja Vis dato og fuldt tidsstempel.
annoncør-ID, kanal-ID Ja Den involverede annoncør og kanal.
url Ja Side-URL, hvor visningen fandt sted.
henvisning Ja HTTP-henvisning.
banner-ID Ja Det viste banner.
marked Ja Marketingkode.
enhedstype Ja desktop, mobil, tablet eller backend

Leads

POST /leads

Tilgængelig for

Kun affilierede. Understøtter i øjeblikket et begrænset antal integrerede annoncører.

Anmod om data

Felter Beskrivelse
kanal-id Påkrævet. Skal være en af dine egne kanaler.
annoncør-id Påkrævet. Skal være en annoncør integreret med Leads API'en og skal have en aktiv relation til den angivne kanal.
(andre felter) Annoncørspecifik — videregives til annoncørens lead management system.

Svaret returneres uændret fra annoncørens lead management system i stedet for det sædvanlige resultater/meta-format, der bruges af andre slutpunkter.

Udbetalinger

GET /payouts

Tilgængelig for

Kun affilierede.

Anmodningsparametre

Parameter Beskrivelse
fraDato, tilDato Valgfri. Filtrer efter oprettelsesdato.

Svarfelt

Felt Filtrerbar Beskrivelse
id Ja Udbetalings-ID.
affiliateId Ja Dit affiliate-konto-ID.
dato oprettet Ja Udbetalingsdato og hvornår udbetalingen blev oprettet.
navn Ja Modtagerens navn.
udbetalingsdato Ja Hvornår udbetalingen faktisk blev foretaget.
adresse, postnummer, by, land Ja Modtagerens adresse.
organisationsnummer, momsnummer Ja Organisationsnummer og momsnummer.
status Ja Betalingsstatus.
sum, moms, total Ja Beløb før moms, momsbeløb og totalbeløb.
valuta Ja Betalingsvaluta.
udbetalingsmetode Ja F.eks. hvilken bankmetode der bruges.
gigapayPayoutId Ja Reference til Gigapay-udbetalingen, hvis den bruges.
gigapayPayout — Udvidede detaljer om Gigapay-udbetalingen, hvis den bruges.
valutavekslingsgebyr Ja Valutavekslingsgebyr, hvis relevant.
skattesats Ja Anvendt skattesats.
bankland Ja Bankland, hvis relevant.
manuel justering Ja Enhver manuel justering af udbetalingen.
antal transaktioner — Antal inkluderede transaktioner.
kickbackRows, antal kickbackRows — Rækker for tilbagebetaling, hvis der er nogen.
sprog — Det sprog, betalingsdokumentet blev genereret på.
kontonummer — Modtagerens bankkontonummer.
periodeFra, periodeTil, periodeTekst — Den periode, som denne betaling dækker.
vatText — Momstekst, der vises på betalingsdokumentet.
reverseCharge — Hvis omvendt betalingspligt gælder.
rækker — Linjeposter på betalingsdokumentet.
transaktioner — Objekt indekseret på transaktions-ID — samme felt som transaktionsslutpunktet nedenfor.

Produktfeeds

GET /productfeeds

Tilgængelig for

Alle kontotyper.

Affilierede konti ser feedmetadata for hver annoncør med en fuldført feedhentning — indsend channelId for at begrænse dette til annoncører med en aktiv relation til den pågældende kanal, som også tagger feed-URL'en til den pågældende kanals sporing. Annoncør- og bureaukonti ser altid kun deres egne annoncør(er)s feeds.

Anmodningsparametre

Parameter Beskrivelse
kanal-ID Valgfrit. Se ovenfor.
detektedCurrency Valgfrit. Filtrerer til feeds, hvor den automatisk detekterede valuta matcher.
detektedLanguage Valgfrit. Filtrerer til feeds, hvor det automatisk detekterede sprog matcher.

Datofiltre (fromDate/toDate) og paginering understøttes ikke på dette slutpunkt — det returnerer altid hele resultatsættet for hver fuldført feedhentning.

Svarfelter

Felter Filtrerbar Beskrivelse
annoncør-ID Ja Den annoncør, som dette feed tilhører.
annoncørnavn — Annoncørens viste navn.
marked — Markedskoden, som feedet gælder for.
sourceProductFeedUrl — Annoncørens oprindelige feed-URL.
url/productFeedUrl — Kun med kanal-ID. Din kanaltaggede feed-URL.
startet, afsluttet Ja Hvornår feedhentningen startede og afsluttedes. Samme værdier som latestFetchDate/latestFetchFinished nedenfor.
latestFetchDate, latestFetchFinished — Duplikerede, mere læsbare navne for startet/afsluttet.
checksum Ja Checksum for det hentede feed til ændringsdetektion. Samme værdi som latestFetchChecksum.
latestFetchChecksum — Duplikat af checksum.
produkter — Antal produkter i feedet.
hasGtin — Antal produkter i feedet, der har et GTIN.
detektedCurrency, detektedLanguage Ja Registrer automatisk valuta og sprog for feedet.

Produkter

HENT /products

Tilgængelig for

Alle kontotyper.

Annoncør- og bureaukonti ser deres eget fulde katalog, inklusive skjulte produkter. Affilierede konti ser kun synlige produkter fra annoncører med en aktiv markedsplads.

Anmodningsparametre

Parameter Beskrivelse
grænse Valgfrit. Antal produkter pr. side.
side Valgfrit. Sidetal.
kanal-ID Valgfrit (affilierede). Tilføjer et trackingLink for hvert produkt.

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

Datofiltre (fromDate/toDate) understøttes ikke på dette slutpunkt.

Svarfelter

Felt Filtrerbar Beskrivelse
id Ja Internt produkt ID.
annoncør-ID Ja Annoncøren, der sælger produktet.
marked Ja Markedskode.
titel Ja Produkttitel.
link Ja Produktside-URL.
product_type, google_product_category Ja Kategorifelt, i henhold til Google Shopping-feedspecifikationen.
image_link Ja Produktbillede-URL.
tilstand Ja F.eks. ny.
tilgængelighed Ja F.eks. på_lager.
pris, salgspris, valuta Ja Normalpris, salgspris og valuta.
forsendelse, størrelse, farve, køn, materiale, aldersgruppe Ja Produktattributter, når tilgængelige.
min._håndteringstid, max_handling_time — Håndteringstid i dage før levering, kun inkluderet, når annoncøren har konfigureret en standardværdi for deres feed.
brand Ja Brand.
sku, mpn, gtin, product_id, item_group_id Ja Produkt-id.
  skjult Ja Hvis produktet er skjult for ikke-annoncørkonti.
checksum Ja Checksum af produktdataene til ændringsdetektion.
has_image_link Ja Hvis en billed-URL er tilgængelig.
trackingLink — Kun med channelId. Dit kanal-brandede link til produktsiden.

Programmer

GET /programs

Tilgængelig for

Alle kontotyper.

Affilierede konti ser kun aktive programmer. Annoncør- og bureaukonti ser alle deres programmer uanset status.

Anmodningsparametre

Parameter Beskrivelse
fromDate, toDate Valgfri. Filtrer efter oprettelsesdato.

Svarfelt

Felt Filtrerbar Beskrivelse
id, navn Ja Program-ID og navn.
procent, beløb, valuta Ja Provisionssats — procent for variabel, beløb/valuta for fast.
status Ja Programmets status.
kommissionstype Ja variabel eller fast.
konverteringsevent-id Ja Den begivenhedstype, som dette program betaler provision for.
kommissionKort — Læselig kommission, f.eks. "15%" eller "30 EUR".
kommissionsværdi, kommissionsenhed — Den numeriske kommissionsværdi og dens enhed (% eller valutakode).
kommission — Længere læsbar form, f.eks. "Fast (30 EUR)".
tieredCommissionModel, tieredCommissionStartDate Ja Tiered model og hvornår den træder i kraft, hvis den er tiered.
channelId — Angives kun for kanaleksklusive programmer.
markeder — Matrix af markedskoder, som programmet gælder for.
niveauer — Kun for trinvise programmer. Hvert trin har transaktioner, værdi, beløb/valuta, kommissionsKort, transaktionstekst.
regler — Kun når betingede kommissionsregler er konfigureret i applikationen.

Relationer

GET /relations

Tilgængelig for

Alle kontotyper, begrænset til dine egne relationer som sædvanlig — der er ingen adfærdsmæssig forskel mellem kontotyper ud over det.

Anmodningsparametre

Parameter Beskrivelse
fradato, tildato Valgfrit. Filtrer efter oprettelsesdato.
opdateretfradato, opdaterettildato Valgfrit. Filtrer efter datoen, hvor relationen sidst blev opdateret.

Svarfelt

Felt Filtrerbar Beskrivelse
id Ja Relationens ID.
annoncør-ID Ja Annoncørsiden for relationen.
annoncørnavn — Annoncørens viste navn.
kanal-id Ja Kanalside for relationen.
kanalnavn, kanaltype, kanalkategori — Kanalnavn, type og kategori.
oprettet, opdateret Ja Hvornår relationen blev oprettet og sidst opdateret.
status Ja Relationens status, f.eks. aktiv.
opsigelsesdato, opsigelsesdage Ja Opsigelsesvarslingsperiode, hvis forholdet er ved at slutte.
sluttede dato, slutteårsag Ja Hvornår og hvorfor forholdet sluttede, hvis relevant.
aktiveret dato Ja Hvornår forholdet blev aktivt.
trackingLink — Din kanals sporingslink til denne annoncør.
programmer — Matrix af provisionsprogrammer tilgængelige på denne relation — samme felter som programslutpunktet ovenfor, plus individualCommission: sand når denne kanal har sin egen provisionsoverstyring for det program (i hvilket tilfælde procent/beløb allerede afspejler overstyringen).

Statistik

GET /stats

Tilgængelig for

Alle kontotyper. Annoncør- og bureaukonti modtager også felter for mæglergebyr (brokerageFee, totalBrokerageFee, deniedBrokerageFee, denialRateBrokerageFee) i svaret; disse er ikke inkluderet for affiliate-konti, da mæglergebyret er platformens margin oven i affiliatens provision.

Anmodningsparametre

Parameter Beskrivelse
groupBy Valgfri. Aggregerer svaret efter en eller flere dimensioner: dato, annoncør, kanal og/eller program. Hvis udeladt, vil svaret være en enkelt aggregeret total. Kombiner flere dimensioner med kommaer, f.eks. groupBy=dato,kanal.
valuta Valgfrit. En 3-bogstavskode for den valuta, som det monetære felt skal konverteres til. Standardværdien er din kontovaluta.
annoncørId, kanalId, programId, marked Valgfrit. Filtrerer aggregeringen til en specifik annoncør, kanal, program og/eller marked.
fromDate, toDate Valgfrit. Filtrer efter dato — dette slutpunkt aggregerer på dato, ikke oprettelse.

Svarfelt

Felt Beskrivelse
annoncør-ID/annoncørnavn, kanal-ID/kanalnavn, program-ID/programnavn, affiliate-ID, marked Kun inkluderet for de dimensioner, du har grupperet på.
dato/uge/måned/kvartal/år Kun inkluderet, når du grupperer efter dato.
klik, visninger Antal klik og visninger.
transaktioner, transaktionerInkl. klik Antal transaktioner, med og uden klikbaserede konverteringer inkluderet.
salg Samlet salgsværdi.
kommission Samlet kommission.
afviste transaktioner, afvist kommission Antal afviste transaktioner og deres kommission.
totalTransactions Samlet antal transaktioner, inklusive afviste.
uniqueAdvertisersWithClicks/uniqueChannelsWithClicks/uniqueMarketsWithClicks Antal unikke forekomster blandt klik i denne gruppe.
uniqueAdvertisersWithTransactions/uniqueChannelsWithTransactions/uniqueMarketsWithTransactions Antal unikke forekomster blandt transaktioner i denne gruppe.
uniqueMarketsWithClicksGroup De specifikke markedskoder, der vises, som en streng.
epc Indtjening pr. klik.
cr Konverteringsrate.
aov Gennemsnitlig ordreværdi.
valuta Valuta for de monetære felter.

Dette slutpunkt returnerer forudberegnede statistikker i stedet for individuelle poster, så dets felter kan ikke filtreres felt for felt som de andre slutpunkter - brug i stedet anmodningsparametrene ovenfor.

Sporingsfejl

GET /trackingErrors

Tilgængelig for

Alle kontotyper, begrænset til dine egne annoncører/kanaler som sædvanlig — der er ingen adfærdsmæssig forskel mellem kontotyper ud over det.

Anmodningsparametre

Parameter Beskrivelse
fromDate, toDate Valgfri. Filtrer efter dato.

Svarfelt

Felt Filtrerbar Beskrivelse
id Ja Sporingsfejl-ID.
dato Ja Hvornår fejlen opstod.
kanal-ID, annoncør-ID Ja Den involverede kanal og annoncør.
redirectUrl Ja Den URL, som klikket forsøgte at omdirigere til, hvis nogen.
clickUrl Ja Den sporings-URL, der blev kaldt.
besked Ja Beskrivelse af, hvad der gik galt.
henviser Ja HTTP-henviser.

Transaktioner

GET /transactions

Tilgængelig for

Alle kontotyper. Annoncør- og bureaukonti modtager også felter for mæglergebyr (brokerageMarkup, brokerageFee, deniedBrokerageFee, originalBrokerageFee) i svaret; Disse er ikke inkluderet for affilierede konti.

Anmodningsparametre

Parameter Beskrivelse
includeClicks Valgfri. Indstil til 1 for at inkludere en række af de klik, der gik forud for hver transaktion.
includeProducts Valgfri. Indstil til 1 for at inkludere linjeposter (produkter) for hver transaktion.
includeTransactionListStatus Valgfri. Indstil til 1 for at inkludere status for den udbetalingsgruppe, som hver transaktion tilhører.
orderBy Valgfri. Sorteringsrækkefølge for resultaterne, f.eks. oprettet DESC.
fromDate, toDate Valgfri. Filtrer efter oprettelsesdato.
opdateretFraDato, opdateretTilDato Valgfrit. Filtrer efter datoen, hvor transaktionen sidst blev opdateret.

Svarfelt

Felt Filtrerbar Beskrivelse
id Ja Transaktions-ID.
dato, oprettet, opdateret Ja Transaktionsdato, oprettelsestidsstempel og sidste opdateret-tidsstempel.
kanal-id, annoncør-id Ja Den involverede kanal og annoncør.
kanalnavn, annoncørnavn — Deres viste navn.
program-id Ja Det anvendte provisionsprogram.
programnavn Ja Navn på provisionsprogrammet.
eventId Ja Den underliggende sporingshændelse, som denne transaktion blev oprettet ud fra.
provisionstype Ja variabel eller fast.
provisionsprocent, provisionsbeløb Ja Den anvendte sats, der svarer til provisionstypen.
eventValue, currency Ja Ordreværdi og valuta.
conversionEventId Ja Typen af konverteringshændelsen, f.eks. Køb.
status Ja ny, godkendt, afvist, forsinket eller udbetalt.
begivenhedsordre-ID Ja Annoncørens eget ordre-ID.
udbetalings-ID Ja Udbetalingen, som denne transaktion var en del af, da den var betalt.
transaktionslisteId Ja Udbetalingsgruppen, som denne transaktion tilhører.
transaktionslisteStatus — Kun med includeTransactionListStatus. Status for den udbetalingsbatch.
clickRef, clickId Ja Referencer til det oprindelige klik.
clickDate/klik — Kun med includeClicks. Det/de klik, der gik forud for denne transaktion.
produkter — Kun med includeProducts. Linjeelementer — hver med id, product_id, title, category, brand, quantity, price, total.
denyReason, denyReasonCategory, denyDate Ja Angiv, hvornår transaktionen blev afvist.
market Ja Markedskode.
rabatkoder Ja Rabatkode(r) brugt i ordren, hvis sporet.
affiliateGclid, wctid Ja Klik-ID'er fra Google Ads / andre annonceplatforme, hvis tilgængelige.
ikke-sporet salg Ja Hvis dette blev tilføjet manuelt som et ikke-sporet salg.
clickCount Ja Antal klik tilknyttet denne transaktion.
individualCommissionId Ja Angiv, hvornår en kanalspecifik kommissionstilsidesættelse anvendes.
commissionSource Ja Hvor kommissionen kommer fra, f.eks. program, individuelKommission.
forsinketIndtil Ja Dato, hvor transaktionen tilbageholdes indtil, hvis forsinket.
under-ID'er Ja Dine egne under-ID-parametre, hvis sendt.
kilde Ja Transaktionens kilde.
kommission, kommissionstekst — Beregnet kommissionsbeløb og dets menneskeligt læsbare form.
originalkommission — Kommission før eventuelle justeringer.
valutaer — Objekter indekseret efter valutakode, hver med kurs, kommission, eventværdi, originalkommission — en valutakonverteret visning af den samme transaktion.

Opdatering en transaktions status

PATCH /transactions/status/{id}

Tilgængelig for

Kun for annoncører.

Opdaterer status for en transaktion. Svaret indeholder den opdaterede transaktion i samme format som ovenfor.

Anmod om data

{ "status": "godkendt"

Du kan også slå en transaktion op efter dens eget ordre-ID i stedet for dens adresse/omsætningstransaktions-ID — udelad {id} fra stien og send { "orderId": "dit-ordre-id", "status": "godkendt" .

Accepterede status-værdier: ny, godkendt, afvist, forsinket. En transaktion kan ikke længere ændres, når den er blevet inkluderet i en udbetalingsbatch, der har forladt den afventende tilstand.

Ændringslog

2026-09-02: API-referencen er udvidet med alle tilgængelige slutpunkter og deres fulde anmodnings- og svarparametre.

2026-08-04: Rettelse af GET /products, så andre konti end annoncøren selv ikke længere ser produkter fra annoncører, hvis markedsplads ikke er aktiv.

2026-07-28: Tilføjelse af anmodningsparameteren includeProducts til GET /transactions.

2026-07-16: Rettelse af GET /relations, der nogle gange inkluderer kanaleksklusive programmer, der ikke gjaldt for den angivne kanal.

2026-06-25: Rettelse af korrektheden af detectedCurrency/detectedLanguage på GET /productfeeds. GET /products inkluderer nu min_handling_time/max_handling_time, når annoncøren har konfigureret en standardværdi.

2026-06-02: Rettelse af pagineringslinket links.prev, som kunne vises forkert på den første resultatside.

2026-05-15: Tilføjelse af felterne detectedCurrency og detectedLanguage til svaret fra GET /productfeeds.

2026-04-28: Tilføjelse af GET /brokenLinks-slutpunktet.

2026-04-07: Tilføjelse af landingPages-feltet til svaret fra GET /advertisers (tilgængelig med expand=1).

2026-03-06: Tilføjelse af conversionEventId-feltet til svaret fra GET /programs.

2026-01-25: Rettede anmodningsparametrene updatedFromDate/updatedToDate, som tidligere ikke blev anvendt på grund af et internt navnekonflikt.

2024-09-18: Omdøbte pagineringsparametrene fra productsPerPage og selectedPage for at begrænse og udligne.

2022-05-12: Tilføjede et nyt /payouts-slutpunkt, hvor affiliates kan hente alle udbetalinger.

2022-04-28: Tilføjede et nyt /productfeeds-slutpunkt, hvor affiliates kan hente en liste over alle produktfeed-URL'er.

2022-04-27: Tilføjede et nyt /relations-slutpunkt for at liste dine relationer mellem kanaler og annoncører.

2022-04-22: Tilføjede muligheden for at gruppere /stats på flere dimensioner.

2022-04-21: Tilføjet til channelId som en anmodningsparameter til /advertisers-slutpunktet for at begrænse svaret til annoncører med relationer til den angivne kanal.

2022-04-20: Tilføjet /stats-slutpunktet for at hente aggregeret statistik.

2022-04-19: Tilføjet muligheden for at begrænse svar fra bestemte slutpunkter, såsom transaktioner og begivenheder, ved hjælp af fromDate- og/eller toDate-forespørgselsstrengparametrene.

2022-03-22: Når channelId sendes til /campaigns-slutpunktet, vises nu kun kampagner for annoncører med en godkendt relation til kanalen.

2022-03-19: Tilføjet anmodningsparameteren includeClicks til /transactions-slutpunktet for at inkludere alle tidligere klik i et array.

2022-03-18: Tilføjet trackingLink til svaret fra slutpunktet /campaigns, hvis parameteren channelId er angivet.

2022-03-18: Tilføjet advertiserName til svaret fra slutpunktet /campaigns.

2022-03-18: Tilføjet advertiserName til svaret fra slutpunktet /banners.

×

Opret konto

Vælg den kontotype, der passer bedst til din profil