Referens för Adrevenue API

Addrevenue API-referens (utkast)

Vårt REST-API har utvecklats för att stödja affiliates och annonsörers behov. Du genererar ett livstids-API-token manuellt i vårt användargränssnitt. Detta Bearer-token skickas sedan som en Authorization-header i varje förfrågan.

API-bas-URL

Alla endpoints börjar med bas-URL:en:

https://addrevenue.io/api/v2

Använd alltid HTTPS-protokollet.

Autentisering

För att generera ett token, logga in på Addrevenue och gå till API tokens, klicka sedan på Generate a new API token. Detta skapar ett unikt livstids-API-token för det inloggade kontot.

Token ska sedan skickas som ett Bearer-token i alla förfrågningar till valfri API-endpoint.

Exempel på en header:

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

Fel

Om du skickar ett tomt, felformaterat eller ogiltigt Bearer-token resulterar det i ett av dessa HTTP-fel:

Status Meddelande Orsak
400 Authorization header not found Authorization-headern saknas eller är felformaterad, till exempel utan prefixet "Bearer".
403 Invalid token Headern är korrekt formaterad, men det angivna API-tokenet finns inte.
403 Inactive account Headern är korrekt formaterad och tokenet finns, men det tillhör ett konto som inte är aktivt.
403 (endpoint-specifikt meddelande) Endpointen är inte tillgänglig för denna kontotyp, till exempel "Endpoint only available to affiliates".
404 Endpoint not found Den efterfrågade endpointen finns inte.

Felsvar ser ut så här:

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

Svar

Alla svar levereras i JSON-format. Ett lyckat svar innehåller en results-array, ett meta-objekt (antal poster och paginering) samt ett links-objekt (pagineringslänkar):

{
    "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 är alltid en array, även vid ett enda resultat. meta.totalCount är det totala antalet matchande poster över alla sidor, inte bara den aktuella sidan. Nedan listar varje endpoint vilka fält du kan förvänta dig i varje objekt i results, och vilka av dessa fält som även kan användas som filter.

API-endpoints

Begäransparametrar

Du kan filtrera de flesta endpoints genom att lägga till en query-sträng-parameter med samma namn som ett av objektets egna fält — till exempel id, status, market, advertiserId eller channelId. Detta fungerar bara för fält som har ett statiskt, lagrat värde — respektive endpoints tabell över svarsfält nedan markerar vilka fält som går att filtrera på detta sätt. Det fungerar inte för fält som är beräknade eller härledda från annan data (till exempel advertiserName, commissionShort eller epc), eller för nästlade objekt och arrayer (till exempel markets eller programs). Att filtrera på ett fält som inte går att filtrera på returnerar ett fel istället för att tyst ignoreras.

Paginering

Använd limit (antal poster per sida) och page (sidnummer, 1-baserat) för att bläddra genom resultat, till exempel /products?limit=50&page=2. offset stöds också som ett äldre alternativ till page.

Datumintervall

För de endpoints där det är tillämpligt kan du filtrera på ett datumintervall med fromDate och/eller toDate — antingen tillsammans, för att sätta ett intervall, eller var för sig. Detta filtrerar på postens skapandedatum (dess date-fält, för stats och trackingErrors) — respektive endpoint nedan anger om detta stöds.

Där det anges kan du även använda updatedFromDate/updatedToDate, som filtrerar på det datum en post senast uppdaterades istället för när den skapades.

Annonsörer

GET /advertisers

Tillgänglig för

Alla kontotyper.

Affiliate-konton ser alla aktiva annonsörer — skicka med channelId för att begränsa listan till annonsörer med en relation (aktiv, väntande eller avvisad) till den kanalen. Advertiser-konton ser endast sitt eget konto. Agency-konton ser de annonsörer de förvaltar.

Begäransparametrar

Parameter Beskrivning
channelId Valfri (endast affiliates). Begränsar resultatet till annonsörer med en relation till denna kanal, och lägger till relation/relationStatus i varje resultat.
expand Valfri. Sätt till 1 för att även inkludera programs och landingPages för varje annonsör.
fromDate, toDate Valfri. Filtrera på skapandedatum.

Svarsfält

Fält Filtrerbart Beskrivning
id Ja Annonsörens ID.
name Ja Juridiskt företagsnamn.
displayName Ja Publikt visningsnamn.
address, zipcode, city, country Ja Företagets adress.
shortDescription — Kort marknadsföringsbeskrivning.
categoryId Ja Kategori, t.ex. insurance, foodDrink.
logoImageFilename — Absolut URL till logotypbilden.
url — Annonsörens webbplats.
type — Alltid advertiser.
orgno, vatno Ja Organisationsnummer och VAT-nummer.
businessType — Typ av bolagsform.
autoApproveChannels Ja Om nya kanalrelationer godkänns automatiskt.
policyPaidAds/restrictionPaidAds Ja Policy för betald annonsering (allowed/notAllowed) samt eventuell fritextrestriktion.
policySocialMedia/restrictionSocialMedia Ja Policy och restriktion för sociala medier.
policyEmailMarketing/restrictionEmailMarketing Ja Policy och restriktion för e-postmarknadsföring.
policyCouponRebate/restrictionCouponRebate Ja Policy och restriktion för rabattkoder.
policyCashbackReward/restrictionCashbackReward Ja Policy och restriktion för cashback/belöning.
ecommercePlatform Ja T.ex. shopify, customBuilt.
trackingMethod Ja Metod för spårningsintegration.
discountCodeTracking Ja Om spårning av rabattkoder är aktiverad.
approvedForPrepayouts Ja Om annonsören är godkänd för förskottsutbetalningar.
customTrackingParameters Ja Extra query-parametrar som läggs till i spårningslänkar.
markets — Objekt indexerat på marknadskod. Varje marknad har market, displayName, url, status, presentation (HTML), shortDescription, affiliatePageUrl, productFeedUrl, redirectUrl, endedDate, endedReason, activatedDate, productCount.
programs — Endast med channelId eller expand. Kommissionsprogram — se endpointen Programs för fältdetaljer.
landingPages — Endast med expand.
relation/relationStatus — Endast med channelId. Din kanals relation till denna annonsör, och dess status.

Banners

GET /banners

Tillgänglig för

Alla kontotyper.

Affiliate-konton ser bannergrupper för alla aktiva annonsörer — skicka med channelId för att även få en spårningskod för varje banner. Advertiser- och Agency-konton ser alla bannergrupper för sin(a) egen(a) annonsör(er), inklusive inaktiva.

Begäransparametrar

Parameter Beskrivning
channelId Valfri (endast affiliates). Om angiven inkluderas spårningskoder för alla banners i svaret.
fromDate, toDate Valfri. Filtrera på skapandedatum.

Svarsfält

Fält Filtrerbart Beskrivning
id Ja Bannergruppens ID.
created Ja När bannergruppen skapades.
name, description Ja Bannergruppens namn och beskrivning.
url Ja Valfri destinations-URL som skriver över gruppens standard.
advertiserId Ja Annonsören denna grupp tillhör.
advertiserName — Annonsörens visningsnamn.
banners — Objekt indexerat på banner-ID. Varje banner har id, created, width, height, filesize, format, filename, samt, endast med channelId, trackingLink, imageLink, bannerHtmlCode (ett färdigt <a><img></a>-utdrag att bädda in).

Trasiga länkar

GET /brokenLinks

Tillgänglig för

Endast affiliate.

Svarsfält

Fält Filtrerbart Beskrivning
id — Den trasiga länkens ID.
url — Den trasiga URL:en.
httpCode — Den påträffade HTTP-statuskoden, t.ex. 404.
created — När den trasiga länken upptäcktes.

Denna endpoint täcker alltid ett fast 30-dagarsfönster och returnerar hela resultatmängden — request-parametrar (inklusive paginering och datumfilter) stöds inte här.

Kampanjer

GET /campaigns

Tillgänglig för

Alla kontotyper.

Affiliate-konton ser alla publika, aktiva kampanjer för alla annonsörer, plus eventuella kanalexklusiva kampanjer för sina egna kanaler — skicka med channelId för att begränsa till annonsörer med en godkänd relation till den kanalen, vilket även lägger till en trackingLink för varje kampanj. Advertiser- och Agency-konton ser alla kampanjer för sin(a) egen(a) annonsör(er) — aktiva och inaktiva, publika och kanalexklusiva.

Begäransparametrar

Parameter Beskrivning
channelId Valfri (endast affiliates). Begränsar till annonsörer med en godkänd relation till kanalen, och lägger till trackingLink för varje kampanj.
fromDate, toDate Valfri. Filtrera på skapandedatum.

Svarsfält

Fält Filtrerbart Beskrivning
id Ja Kampanjens ID.
advertiserId Ja Annonsören som driver kampanjen.
advertiserName, advertiserUrl — Annonsörens visningsnamn och webbplats.
description Ja Kampanjbeskrivning.
discountCode Ja Rabattkoden, om detta är en kupongkampanj.
url Ja Landningssida för kampanjen.
terms Ja Villkorstext.
validFrom, validTo Ja Giltighetsperiod.
channelId Ja Sätts endast för kanalexklusiva kampanjer.
created Ja När kampanjen skapades.
bannerGroupId Ja Länkad bannergrupp, om någon.
type — coupon eller offer.
status — active eller ended.
markets — Array med marknadskoder kampanjen gäller för.
trackingLink — Endast med channelId. Din kanalmärkta länk till kampanjens URL.

Kanaler

GET /channels

Tillgänglig för

Endast affiliate.

Begäransparametrar

Parameter Beskrivning
fromDate, toDate Valfri. Filtrera på skapandedatum.

Svarsfält

Fält Filtrerbart Beskrivning
id Ja Kanalens ID.
affiliateId Ja Ditt affiliate-kontos ID.
name, url Ja Kanalens namn och webbplats-URL.
type Ja T.ex. website.
visitors Ja Uppskattad besöksvolym.
status Ja Kanalens status.
created Ja När kanalen skapades.
markets — Array med marknadskoder, eller null.

Händelser

GET /events

Tillgänglig för

Alla kontotyper, avgränsat till din(a) egen(a) annonsör(er)/kanal(er) som vanligt — det finns ingen beteendeskillnad mellan kontotyper utöver det.

Begäransparametrar

Parameter Beskrivning
fromDate, toDate Valfri. Filtrera på skapandedatum — observera att detta filtrerar på created, inte på det separata date-fältet i svaret.

Svarsfält

Fält Filtrerbart Beskrivning
id Ja Eventets ID.
date, created Ja Eventets datum och fullständiga tidsstämpel.
advertiserId, channelId Ja Annonsören och kanalen som är inblandade.
type Ja Eventtyp, t.ex. Click. Detta varierar per annonsörsintegration och är ingen fast lista.
url Ja Sid-URL där eventet inträffade.
value, currency Ja Ordervärde och valuta, om tillämpligt.
orderId Ja Annonsörens eget order-ID, om tillämpligt.
sandbox Ja Om detta var ett test-/sandbox-event.
referrer Ja HTTP-referrer.
clickId Ja Klicket detta event är kopplat till.
bannerId Ja Bannern som klickades, om någon.
clickRef Ja Intern klickreferens.
market Ja Marknadskod.
redirectUrl Ja Annonsörens landningssida som klicket omdirigerades till.
affiliateUrl Ja Den ursprungliga affiliate-sidans URL.
affiliateGclid, wctid Ja Klick-ID:n från Google Ads / andra annonsplattformar, om de finns.
easylink Ja Om detta event kom via en Easylink.
deviceType Ja desktop, mobile, tablet eller backend.
crossDeviceId Ja Enhetsöverskridande spårnings-ID, om tillgängligt.
subids Ja Dina egna sub-ID-parametrar, om skickade.

Visningar

GET /impressions

Tillgänglig för

Alla kontotyper, avgränsat till din(a) egen(a) annonsör(er)/kanal(er) som vanligt — det finns ingen beteendeskillnad mellan kontotyper utöver det.

Begäransparametrar

Parameter Beskrivning
fromDate, toDate Valfri. Filtrera på skapandedatum.

Svarsfält

Fält Filtrerbart Beskrivning
id Ja Visningens ID.
date, created Ja Visningens datum och fullständiga tidsstämpel.
advertiserId, channelId Ja Annonsören och kanalen som är inblandade.
url Ja Sid-URL där visningen inträffade.
referrer Ja HTTP-referrer.
bannerId Ja Bannern som visades.
market Ja Marknadskod.
deviceType Ja desktop, mobile, tablet eller backend.

Leads

POST /leads

Tillgänglig för

Endast affiliate. Stöder för närvarande ett begränsat antal integrerade annonsörer.

Begäransdata

Fält Beskrivning
channelId Obligatorisk. Måste vara en av dina egna kanaler.
advertiserId Obligatorisk. Måste vara en annonsör som är integrerad med Leads-API:et, och måste ha en aktiv relation med den angivna kanalen.
(övriga fält) Annonsörsspecifika — skickas vidare till annonsörens system för leadshantering.

Svaret returneras oförändrat från annonsörens system för leadshantering, snarare än det vanliga results/meta-formatet som används av övriga endpoints.

Utbetalningar

GET /payouts

Tillgänglig för

Endast affiliate.

Begäransparametrar

Parameter Beskrivning
fromDate, toDate Valfri. Filtrera på skapandedatum.

Svarsfält

Fält Filtrerbart Beskrivning
id Ja Utbetalningens ID.
affiliateId Ja Ditt affiliate-kontos ID.
date, created Ja Utbetalningsdatum och när utbetalningen skapades.
name Ja Mottagarens namn.
payoutDate Ja När utbetalningen faktiskt genomfördes.
address, zipcode, city, country Ja Mottagarens adress.
orgno, vatno Ja Organisationsnummer och VAT-nummer.
status Ja Utbetalningens status.
sum, vat, total Ja Belopp före moms, momsbelopp och totalt belopp.
currency Ja Utbetalningens valuta.
payoutMethod Ja T.ex. vilken bankmetod som används.
gigapayPayoutId Ja Referens till Gigapay-utbetalningen, om sådan används.
gigapayPayout — Utökade detaljer om Gigapay-utbetalningen, om sådan används.
currencyExchangeFee Ja Avgift för valutaväxling, om någon.
taxRate Ja Tillämpad skattesats.
bankCountry Ja Bankland, om tillämpligt.
manualAdjustment Ja Eventuell manuell justering av utbetalningen.
noOfTransactions — Antal inkluderade transaktioner.
kickbackRows, noOfKickbackRows — Kickback-rader, om några.
language — Språket utbetalningsdokumentet genererades på.
accountNumber — Mottagarens bankkontonummer.
periodFrom, periodTo, periodText — Perioden denna utbetalning omfattar.
vatText — Momstext som visas på utbetalningsdokumentet.
reverseCharge — Om omvänd momsskyldighet gäller.
rows — Radposter på utbetalningsdokumentet.
transactions — Objekt indexerat på transaktions-ID — samma fält som endpointen Transactions nedan.

Produktflöden

GET /productfeeds

Tillgänglig för

Alla kontotyper.

Affiliate-konton ser feed-metadata för varje annonsör med en slutförd feed-hämtning — skicka med channelId för att begränsa detta till annonsörer med en aktiv relation till den kanalen, vilket även märker feed-URL:en för den kanalens spårning. Advertiser- och Agency-konton ser alltid endast sin(a) egen(a) annonsör(er)s feeds.

Begäransparametrar

Parameter Beskrivning
channelId Valfri. Se ovan.
detectedCurrency Valfri. Filtrerar till feeds där den automatiskt identifierade valutan matchar.
detectedLanguage Valfri. Filtrerar till feeds där det automatiskt identifierade språket matchar.

Datumfilter (fromDate/toDate) och paginering stöds inte på denna endpoint — den returnerar alltid hela resultatmängden för varje slutförd feed-hämtning.

Svarsfält

Fält Filtrerbart Beskrivning
advertiserId Ja Annonsören denna feed tillhör.
advertiserName — Annonsörens visningsnamn.
market — Marknadskoden feeden gäller för.
sourceProductFeedUrl — Annonsörens ursprungliga feed-URL.
url/productFeedUrl — Endast med channelId. Din kanalmärkta feed-URL.
started, finished Ja När feed-hämtningen startade och slutfördes. Samma värden som latestFetchDate/latestFetchFinished nedan.
latestFetchDate, latestFetchFinished — Duplicerade, mer lättlästa namn för started/finished.
checksum Ja Kontrollsumma för den hämtade feeden, för ändringsdetektering. Samma värde som latestFetchChecksum.
latestFetchChecksum — Dubblett av checksum.
products — Antal produkter i feeden.
hasGtin — Antal produkter i feeden som har ett GTIN.
detectedCurrency, detectedLanguage Ja Automatiskt identifierad valuta och språk för feeden.

Produkter

GET /products

Tillgänglig för

Alla kontotyper.

Advertiser- och Agency-konton ser sin egen fullständiga katalog, inklusive dolda produkter. Affiliate-konton ser endast synliga produkter från annonsörer med en aktiv marknad.

Begäransparametrar

Parameter Beskrivning
limit Valfri. Antal produkter per sida.
page Valfri. Sidnummer.
channelId Valfri (affiliates). Lägger till en trackingLink för varje produkt.

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

Datumfilter (fromDate/toDate) stöds inte på denna endpoint.

Svarsfält

Fält Filtrerbart Beskrivning
id Ja Internt produkt-ID.
advertiserId Ja Annonsören som säljer produkten.
market Ja Marknadskod.
title Ja Produktens titel.
link Ja Produktens sid-URL.
product_type, google_product_category Ja Kategorifält, enligt Google Shopping-feedspecifikationen.
image_link Ja Produktens bild-URL.
condition Ja T.ex. new.
availability Ja T.ex. in_stock.
price, sale_price, currency Ja Ordinarie pris, reapris och valuta.
shipping, size, color, gender, material, age_group Ja Produktattribut, när tillgängliga.
min_handling_time, max_handling_time — Hanteringstid i dagar innan leverans, endast inkluderat när annonsören har konfigurerat ett standardvärde för sin feed.
brand Ja Varumärke.
sku, mpn, gtin, product_id, item_group_id Ja Produktidentifierare.
hidden Ja Om produkten är dold för icke-annonsörskonton.
checksum Ja Kontrollsumma för produktdatan, för ändringsdetektering.
has_image_link Ja Om en bild-URL finns tillgänglig.
trackingLink — Endast med channelId. Din kanalmärkta länk till produktsidan.

Program

GET /programs

Tillgänglig för

Alla kontotyper.

Affiliate-konton ser endast aktiva program. Advertiser- och Agency-konton ser alla sina program oavsett status.

Begäransparametrar

Parameter Beskrivning
fromDate, toDate Valfri. Filtrera på skapandedatum.

Svarsfält

Fält Filtrerbart Beskrivning
id, name Ja Programmets ID och namn.
percent, amount, currency Ja Provisionssatsen — percent för rörlig, amount/currency för fast.
status Ja Programmets status.
commissionType Ja variable eller fixed.
conversionEventId Ja Eventtypen detta program betalar provision på.
commissionShort — Läsbar provision, t.ex. "15%" eller "30 EUR".
commissionValue, commissionUnit — Det numeriska provisionsvärdet och dess enhet (% eller valutakod).
commission — Längre läsbar form, t.ex. "Fixed (30 EUR)".
tieredCommissionModel, tieredCommissionStartDate Ja Trappmodell och när den träder i kraft, om trappad.
channelId — Sätts endast för kanalexklusiva program.
markets — Array med marknadskoder programmet gäller för.
tiers — Endast för trappade program. Varje trappsteg har transactions, value, amount/currency, commissionShort, transactionsText.
rules — Endast när villkorade provisionsregler är konfigurerade på programmet.

Relationer

GET /relations

Tillgänglig för

Alla kontotyper, avgränsat till dina egna relationer som vanligt — det finns ingen beteendeskillnad mellan kontotyper utöver det.

Begäransparametrar

Parameter Beskrivning
fromDate, toDate Valfri. Filtrera på skapandedatum.
updatedFromDate, updatedToDate Valfri. Filtrera på det datum relationen senast uppdaterades.

Svarsfält

Fält Filtrerbart Beskrivning
id Ja Relationens ID.
advertiserId Ja Relationens annonsörssida.
advertiserName — Annonsörens visningsnamn.
channelId Ja Relationens kanalsida.
channelName, channelType, channelCategory — Kanalens namn, typ och kategori.
created, updated Ja När relationen skapades och senast uppdaterades.
status Ja Relationens status, t.ex. active.
noticeDate, noticeDays Ja Uppsägningsperiod, om relationen håller på att avslutas.
endedDate, endedReason Ja När och varför relationen avslutades, om tillämpligt.
activatedDate Ja När relationen blev aktiv.
trackingLink — Din kanals spårningslänk till denna annonsör.
programs — Array med kommissionsprogram tillgängliga på denna relation — samma fält som endpointen Programs ovan, plus individualCommission: true när denna kanal har sin egen provisionsöverstyrning för det programmet (i så fall speglar percent/amount redan överstyrningen).

Statistik

GET /stats

Tillgänglig för

Alla kontotyper. Advertiser- och Agency-konton får dessutom brokerage-fee-fält (brokerageFee, totalBrokerageFee, deniedBrokerageFee, denialRateBrokerageFee) i svaret; dessa inkluderas inte för Affiliate-konton, eftersom brokerage-avgiften är plattformens marginal ovanpå affiliatens provision.

Begäransparametrar

Parameter Beskrivning
groupBy Valfri. Aggregerar svaret efter en eller flera dimensioner: date, advertiser, channel och/eller program. Om detta utelämnas blir svaret en enda aggregerad summa. Kombinera flera dimensioner med kommatecken, t.ex. groupBy=date,channel.
currency Valfri. En 3-bokstavskod för den valuta monetära fält ska konverteras till. Standard är ditt kontos valuta.
advertiserId, channelId, programId, market Valfri. Filtrerar aggregeringen till en specifik annonsör, kanal, program och/eller marknad.
fromDate, toDate Valfri. Filtrera på datum — denna endpoint aggregerar på date, inte created.

Svarsfält

Fält Beskrivning
advertiserId/advertiserName, channelId/channelName, programId/programName, affiliateId, market Inkluderas endast för de dimensioner du grupperat på.
date/week/month/quarter/year Inkluderas endast när du grupperat på date.
clicks, impressions Antal klick och visningar.
transactions, transactionsInclClick Antal transaktioner, med och utan enbart klickbaserade konverteringar inkluderade.
sales Totalt försäljningsvärde.
commission Total provision.
deniedTransactions, deniedCommission Antal nekade transaktioner och deras provision.
totalTransactions Totalt antal transaktioner, inklusive nekade.
uniqueAdvertisersWithClicks/uniqueChannelsWithClicks/uniqueMarketsWithClicks Antal unika förekomster bland klick i denna grupp.
uniqueAdvertisersWithTransactions/uniqueChannelsWithTransactions/uniqueMarketsWithTransactions Antal unika förekomster bland transaktioner i denna grupp.
uniqueMarketsWithClicksGroup De specifika marknadskoder som setts, som en sträng.
epc Intäkt per klick (earnings per click).
cr Konverteringsgrad.
aov Genomsnittligt ordervärde.
currency Valuta för de monetära fälten.

Denna endpoint returnerar förberäknad statistik snarare än enskilda poster, så dess fält går inte att filtrera på fält-för-fält-basis som hos övriga endpoints — använd request-parametrarna ovan istället.

Spårningsfel

GET /trackingErrors

Tillgänglig för

Alla kontotyper, avgränsat till din(a) egen(a) annonsör(er)/kanal(er) som vanligt — det finns ingen beteendeskillnad mellan kontotyper utöver det.

Begäransparametrar

Parameter Beskrivning
fromDate, toDate Valfri. Filtrera på datum.

Svarsfält

Fält Filtrerbart Beskrivning
id Ja Spårningsfelets ID.
date Ja När felet inträffade.
channelId, advertiserId Ja Kanalen och annonsören som är inblandade.
redirectUrl Ja URL:en klicket försökte omdirigera till, om någon.
clickUrl Ja Spårnings-URL:en som anropades.
message Ja Beskrivning av vad som gick fel.
referrer Ja HTTP-referrer.

Transaktioner

GET /transactions

Tillgänglig för

Alla kontotyper. Advertiser- och Agency-konton får dessutom brokerage-fee-fält (brokerageMarkup, brokerageFee, deniedBrokerageFee, originalBrokerageFee) i svaret; dessa inkluderas inte för Affiliate-konton.

Begäransparametrar

Parameter Beskrivning
includeClicks Valfri. Sätt till 1 för att inkludera en array med klicken som föregick varje transaktion.
includeProducts Valfri. Sätt till 1 för att inkludera radposter (produkter) för varje transaktion.
includeTransactionListStatus Valfri. Sätt till 1 för att inkludera statusen för den utbetalningsbatch varje transaktion tillhör.
orderBy Valfri. Sorteringsordning för resultaten, t.ex. created DESC.
fromDate, toDate Valfri. Filtrera på skapandedatum.
updatedFromDate, updatedToDate Valfri. Filtrera på det datum transaktionen senast uppdaterades.

Svarsfält

Fält Filtrerbart Beskrivning
id Ja Transaktionens ID.
date, created, updated Ja Transaktionens datum, skapandetidsstämpel och senast uppdaterad-tidsstämpel.
channelId, advertiserId Ja Kanalen och annonsören som är inblandade.
channelName, advertiserName — Deras visningsnamn.
programId Ja Kommissionsprogrammet som tillämpas.
programName Ja Kommissionsprogrammets namn.
eventId Ja Det underliggande spårningseventet denna transaktion skapades från.
commissionType Ja variable eller fixed.
commissionPercent, commissionAmount Ja Den tillämpade satsen, motsvarande commissionType.
eventValue, currency Ja Ordervärde och valuta.
conversionEventId Ja Konverteringseventets typ, t.ex. Purchase.
status Ja new, approved, denied, delayed eller paidOut.
eventOrderId Ja Annonsörens eget order-ID.
payoutId Ja Utbetalningen denna transaktion ingick i, när den betalats.
transactionListId Ja Utbetalningsbatchen denna transaktion tillhör.
transactionListStatus — Endast med includeTransactionListStatus. Status för den utbetalningsbatchen.
clickRef, clickId Ja Referenser till det ursprungliga klicket.
clickDate/clicks — Endast med includeClicks. Klicket/klicken som föregick denna transaktion.
products — Endast med includeProducts. Radposter — var och en med id, product_id, title, category, brand, quantity, price, total.
denyReason, denyReasonCategory, denyDate Ja Sätts när transaktionen nekades.
market Ja Marknadskod.
discountCodes Ja Rabattkod(er) som använts i ordern, om spårade.
affiliateGclid, wctid Ja Klick-ID:n från Google Ads / andra annonsplattformar, om de finns.
untrackedSale Ja Om detta manuellt lagts till som en ospårad försäljning.
clickCount Ja Antal klick kopplade till denna transaktion.
individualCommissionId Ja Sätts när en kanalspecifik provisionsöverstyrning tillämpats.
commissionSource Ja Varifrån provisionen kommer, t.ex. program, individualCommission.
delayedUntil Ja Datum transaktionen hålls till, om fördröjd.
subids Ja Dina egna sub-ID-parametrar, om skickade.
source Ja Transaktionens ursprung.
commission, commissionText — Beräknat provisionsbelopp och dess läsbara form.
originalCommission — Provision innan eventuella justeringar.
currencies — Objekt indexerat på valutakod, var och en med rate, commission, eventValue, originalCommission — en valutakonverterad vy av samma transaktion.

Uppdatera en transaktions status

PATCH /transactions/status/{id}

Tillgänglig för

Endast advertiser.

Uppdaterar statusen för en transaktion. Svaret innehåller den uppdaterade transaktionen, i samma format som ovan.

Begäransdata

{ "status": "approved" }

Du kan även slå upp en transaktion via ditt eget order-ID istället för dess Addrevenue-transaktions-ID — utelämna {id} från sökvägen och skicka { "orderId": "your-order-id", "status": "approved" }.

Godkända status-värden: new, approved, denied, delayed. En transaktion kan inte längre ändras när den väl har inkluderats i en utbetalningsbatch som lämnat väntande-läget.

Ändringslogg

2026-09-02: Utökade API-referensen med samtliga tillgängliga endpoints och deras fullständiga request- och response-parametrar.

2026-08-04: Åtgärdade GET /products så att andra konton än annonsören själv inte längre ser produkter från annonsörer vars marknad inte är aktiv.

2026-07-28: Lade till request-parametern includeProducts på GET /transactions.

2026-07-16: Åtgärdade att GET /relations ibland inkluderade kanalexklusiva program som inte gällde för den angivna kanalen.

2026-06-25: Åtgärdade korrektheten för detectedCurrency/detectedLanguage på GET /productfeeds. GET /products inkluderar nu min_handling_time/max_handling_time när annonsören har konfigurerat ett standardvärde.

2026-06-02: Åtgärdade pagineringslänken links.prev, som felaktigt kunde visas på den första resultatsidan.

2026-05-15: Lade till fälten detectedCurrency och detectedLanguage i svaret från GET /productfeeds.

2026-04-28: Lade till endpointen GET /brokenLinks.

2026-04-07: Lade till fältet landingPages i svaret från GET /advertisers (tillgängligt med expand=1).

2026-03-06: Lade till fältet conversionEventId i svaret från GET /programs.

2026-01-25: Åtgärdade request-parametrarna updatedFromDate/updatedToDate, som tidigare inte tillämpades på grund av en intern namnkrock.

2024-09-18: Bytte namn på pagineringsparametrarna från productsPerPage och selectedPage till limit och offset.

2022-05-12: Lade till en ny endpoint /payouts för affiliates att hämta alla utbetalningar.

2022-04-28: Lade till en ny endpoint /productfeeds för affiliates att hämta en lista över alla produktflödes-URL:er.

2022-04-27: Lade till en ny endpoint /relations för att lista dina relationer mellan kanaler och annonsörer.

2022-04-22: Lade till möjligheten att gruppera /stats på flera dimensioner.

2022-04-21: Lade till channelId som request-parameter till endpointen /advertisers, för att begränsa svaret till annonsörer med relationer till den angivna kanalen.

2022-04-20: Lade till endpointen /stats för att hämta aggregerad statistik.

2022-04-19: Lade till möjligheten att begränsa svaren från vissa endpoints såsom transactions och events genom att använda query-sträng-parametrarna fromDate och/eller toDate.

2022-03-22: När channelId skickas till endpointen /campaigns visas nu endast kampanjer för annonsörer med en godkänd relation till kanalen.

2022-03-19: Lade till request-parametern includeClicks till endpointen /transactions, för att inkludera alla föregående klick i en array.

2022-03-18: Lade till trackingLink i svaret från endpointen /campaigns, om parametern channelId anges.

2022-03-18: Lade till advertiserName i svaret från endpointen /campaigns.

2022-03-18: Lade till advertiserName i svaret från endpointen /banners.

×

Skapa konto

Välj den kontotyp som bäst passar din profil