Pular para o conteúdo principal

API Reference

Introduction

Optimise Network API for Publishers & Advertisers allows programmatic access to the functionality of Insights Dashboard. This documentaton is written according to Open API 3.0 specifications.

Full API endpoint documentation can be found here: Optimise Network API Docs

Authentication

To authenticate an apikey must be specified in the header of the request.

API Header Example

The API Key can be generated by creating a Service Account in Insights Dashboard. Navigate to Admin > Service Accounts

API Header Example

In addition you must include the following 2 querystring parameters with every request:

?contactId={AID/MID}&agencyId={agencyId}

You can locate your AID or MID from within your account here:

AID or MID

And lookup your agencyId here.

Reference Tables

The following reference tables may be required when querying the API.

CountryId

Country NameCountry CodeCountryID
AfghanistanAF31
AlbaniaAL32
AlgeriaDZ33
American SamoaAS34
AndorraAD35
AngolaAO36
AnguillaAI37
AntarcticaAQ38
Antigua & BarbudaAG39
ArgentinaAR40
ArmeniaAM41
ArubaAW42
AustraliaAU22
AustriaAT14
AzerbaijanAZ43
BahamasBS44
BahrainBH45
BangladeshBD30
BarbadosBB46
BelarusBY47
BelgiumBE11
BelizeBZ48
BeninBJ49
BermudaBM50
BhutanBT51
BoliviaBO52
Bosnia & HerzegowinaBA53
BotswanaBW54
Bouvet IslandBV55
BrazilBR56
Brunei DarussalamBN57
BulgariaBG58
Burkina FasoBF59
BurundiBI60
CambodiaKH61
CameroonCM62
CanadaCA23
Cape VerdeCV63
Cayman IslandsKY64
Central African RepublicCF65
ChadTD66
Channel IslandsGB229
ChileCL67
ChinaCN68
Christmas IslandCX69
ColombiaCO70
CongoCG71
Cook IslandsCK72
Costa RicaCR73
Cote D'ivoireCI74
CroatiaHR75
CubaCU76
CuraçaoCW234
CyprusCY77
Czech RepublicCZ15
DenmarkDK9
DjiboutiDJ78
DominicaDM233
Dominican RepublicDO79
East TimorTL80
EcuadorEC81
EgyptEG82
El SalvadorSV83
Equatorial GuineaGQ84
EritreaER85
EstoniaEE86
EthiopiaET87
Falkland IslandsFK88
Faroe IslandsFO89
FijiFJ90
FinlandFI91
FranceFR2
French GuianaGF92
French PolynesiaPF93
French Southern TerritoriesTF94
GabonGA95
GambiaGM96
GeorgiaGE97
GermanyDE3
GhanaGH98
GibraltarGI28
GlobalGO228
GreeceGR25
GreenlandGL99
GrenadaGD100
GuadeloupeGP101
GuamGU102
GuatemalaGT103
GuineaGN104
Guinea-bissauGW105
GuyanaGY106
HaitiHT107
HondurasHN108
Hong KongHK27
HungaryHU16
IcelandIS109
IndiaIN26
IndonesiaID110
IranIR111
IraqIQ112
IrelandIE10
IsraelIL113
ItalyIT4
Ivory Coast
CI232
JamaicaJM114
JapanJP115
JordanJO116
KazakhstanKZ117
KenyaKE118
KiribatiKI119
KuwaitKW121
KyrgyzstanKG122
Lao People's Democratic RepublicLA123
LatviaLV124
LebanonLB125
LesothoLS126
LiberiaLR127
LibyaLY128
LiechtensteinLI129
LithuaniaLT130
LuxembourgLU19
MacauMO131
MacedoniaMK132
MadagascarMG133
MalawiMW134
MalaysiaMY135
MaldivesMV136
MaliML137
MaltaMT138
Marshall IslandsMH139
MartiniqueMQ140
MauritaniaMR141
MauritiusMU142
MayotteYT143
MexicoMX144
MicronesiaFM145
MoldovaMD146
MonacoMC147
MongoliaMN148
MontenegroME230
MontserratMS149
MoroccoMA150
MozambiqueMZ151
MyanmarMM152
NamibiaNA153
NauruNR154
NepalNP155
NetherlandsNL12
New CaledoniaNC156
New ZealandNZ24
NicaraguaNI157
NigerNE158
NigeriaNG159
NiueNU160
Norfolk IslandNF161
Northern Mariana IslandsMP162
NorwayNO8
OmanOM163
PakistanPK29
PalauPW164
Palestinian TerritoryNULL166
PanamaPA165
Papua New GuineaPG167
ParaguayPY168
PeruPE169
PhilippinesPH170
PitcairnPN171
PolandPL21
PortugalPT13
Puerto RicoPR173
QatarQA174
ReunionRE175
RomaniaRO176
Russian FederationRU177
RwandaRW178
Saint Kitts & NevisKN179
Saint LuciaLC180
Saint Vincent & The GrenadinesVC181
SamoaWS182
San MarinoSM183
Sao Tome & PrincipeST184
Saudi ArabiaSA185
SenegalSN186
SerbiaRS225
SeychellesSC187
Sierra LeoneSL188
SingaporeSG189
Slovakia (Slovak Republic)SK190
SloveniaSI191
Solomon IslandsSB192
SomaliaSO193
South AfricaZA194
South Georgia & The S. S. IslandsGS195
South KoreaKR120
SpainES5
Sri LankaLK196
St. HelenaSH197
St. Pierre & MiquelonPM198
SudanSD199
SwazilandSZ200
SwedenSE7
SwitzerlandCH18
Syrian Arab RepublicSY201
TaiwanTW202
TajikistanTJ203
TanzaniaTZ204
ThailandTH205
TogoTG206
TokelauTK207
TongaTO208
Trinidad & TobagoTT209
TunisiaTN210
TurkeyTR211
TurkmenistanTM212
Turks & Caicos IslandsTC213
TuvaluTV214
UgandaUG215
UkraineUA216
United Arab EmiratesAE217
United KingdomGB1
United StatesUS20
UruguayUY218
UzbekistanUZ219
VanuatuVU220
VenezuelaVE221
VietnamVN222
Virgin IslandsVG223
YemenYE224
ZambiaZM226
ZimbabweZW227

CurrencyId

CurrencycodeCurrencyID
AED33
ARS41
AUD8
BDT28
BGN49
BHD36
BND43
BRL18
CAD9
CHF13
CLP30
CNY23
COP32
CZK15
DKK5
DZD62
EGP40
EUR2
GBP1
GHS54
HKD12
HRK66
HUF22
IDR19
ILS21
INR11
JMD46
JOD38
JPY27
KES55
KHR69
KRW25
KWD56
KZT70
LBP57
MAD35
MOP44
MUR58
MXN31
MYR16
NGN59
NOK4
NZD10
OMR37
PEN42
PHP20
PKR34
PLN7
QAR39
RON67
RSD65
RUB26
SAR60
SEK3
SGD14
THB17
TND63
TRY52
TTD47
TWD45
UAH68
UGX61
USD6
UYU50
VND24
XAF53
XCD51
XOF64
ZAR48

AgencyId

Agency NameAgencyId
Optimise Australia & New Zealand47
Optimise MENA172
Optimise SE Asia118
Optimise UK1
Optimise Global131

SectorId

Sector NameSectorId
Activities155
Airport Parking11
Animal Charities92
Appliances166
Beauty Products85
Betting & Gaming13
Books, Films & Music49
Breakdown Insurance14
Broadband47
Bus Tickets124
Business Credit Cards97
Business Finance96
Business Insurance95
Business Loans99
Business Mortgages98
Business to Business Services110
Car Hire16
Car Insurance1
Caravan Insurance43
Cars81
Children's Charities91
Children's Clothes116
Clothes18
Commerical Vehicle Insurance80
Computers & Software55
Consumer deals104
Credit Cards19
Currency Exchange112
Current Accounts40
Cycling173
Dating76
Debt Management20
Digital TV & VoD21
DIY171
Domain Name Registration22
Education & Courses121
Electronics82
Energy Providers23
EventTickets150
Eyewear164
Fashion Accessories84
Ferries24
Flights25
Flowers170
Food & Drink58
Footwear163
Furniture & Accessories64
Games, Consoles & Toys83
Garden Supplies169
Health & Fitness Services61
Health Insurance36
Holidays26
Home Appliance Cover8
Home Insurance2
Horoscopes115
Hostels125
Hotels28
Household175
International Aid93
Investments & Shares29
Jewellery & Watches86
Job Listings154
Leasing109
Life Insurance3
Loans113
Miscellaneous105
Mobile - Pay as You Go158
Mobile - Sim only156
Mobile Contract32
Mobilty Accessories174
Mortgages9
Motorbike Insurance6
Motorbikes172
News Media153
Office Supplies111
Payday Loans107
Payment Protection Insurance7
Pet Insurance33
Pet Supplies168
Phones, Tablets & Accessories157
Photos167
Pre-paid Cards101
Rail88
Real Estate119
Savings75
Secured Loans30
Society & Health94
Specialist Insurance103
Sport & Fitness Equipment87
Sportswear165
Surveys117
Takeaway/Restaurant123
Tax114
Taxi122
Telecoms27
Travel Insurance4
Travel Money Services102
Unsecured Loans31
Web Hosting35

Rejection Codes

rejectionCodeDescription
202Goods returned, transaction voided
204Another marketing channel was credited with the sale
205Order cancelled or returned
207Transaction not fully completed online
208Another marketing channel was credited with the sale due to a voucher/discount code
209Did not meet the terms and conditions set by the merchant
214Breach of IAB Voucher Code code of conduct
216No transaction recorded / cannot be traced
217No voucher or discount codes so commission not paid for these transactions
218Non qualifying discount code so commission only paid for qualifying discount codes
220Account payment issues
223Exceeded sales per year limit
224Suspicious activity
225Other
226Duplicate sale
227Test Sale
234No commissionable items purchased

File Explorer CategoryId

CategoryNameCategoryID
Validation1
Transaction Enquiries2
Misc3
Cashback Enquiries4
Reward Enquiries5
Validations Return6
Campaign Performance7
Conversion Enquiries8
TQM9
Converison Enquiries Export10
Validation File Export11
Media Packs12
Third Party Validations13
Third Party Validation Items14

Voucher CategoryId

CategoryNameCategoryID
Apparel and Accessories32
Automotive33
Beauty and Personal Care34
Books and Stationary35
Bus Tickets36
Cameras and Accessories37
Cashback72
Computers, Laptops and Gaming38
Dinning67
Electronics39
Entertainment40
Fashion64
Finance65
Flowers and Gifts41
Food and Beverages42
Footwear43
Grocery44
Health45
Home and Decor46
Home and Kitchen47
Hotels48
Industrial Supplies60
Innerwear and Swimwear49
Insurance66
Jewellery and Coins50
Kids and Babies51
Lifestyle69
Miscellaneous61
Mobile Recharge and Bill Payment52
Mobiles and Tablets53
Musical Instruments54
Other63
Retail70
Shopping71
Spa & Wellness68
Sports and Fitness56
Travel and Tours57
Utility Appliances58

Reporting Measures

Measures which can be passed to the reporting endpoint. As noted below, some measures may be restricted according to your account type or settings.

MeasureRestrictions
applicationDeclineEvent      Advertisers only                                
applicationEndEvent          Advertisers only                                
applicationReferralEvent      Advertisers only                                
applicationStartEvent        Advertisers only                                
assistedConversionRate        None                                            
assistedConversions          None                                            
averageCommission            May be restricted based on your account settings
averageCost                  Advertisers only                                
averageOrderValue            None                                            
averageValidatedCost          Advertisers only                                
basketEvent                  Advertisers only                                
clickCommission              May be restricted based on your account settings
clickCost                    Advertisers only                                
clicks                        None                                            
commissionpending            None                                            
completedApplications        May be restricted based on your account settings
contentPageEvent              Advertisers only                                
conversionRate                None                                            
ctr                          None                                            
ecpm                          None                                            
epc                          None                                            
estimatedValidatedCommission  None                                            
estimatedValidatedConversionsNone                                            
estimatedValidatedNetCost    Advertisers only                                
homepageEvent                Advertisers only                                
impressions                  None                                            
landingPageEvent              Advertisers only                                
originalOrderValue            None                                            
pendingCommission            May be restricted based on your account settings
pendingConversions            None                                            
pendingNetCost                Advertisers only                                
pendingReturnOnAdSpend        None                                            
pendingReturnOnInvestment    None                                            
quoteEvent                    Advertisers only                                
quoteStartEvent              Advertisers only                                
rejectedCommission            May be restricted based on your account settings
rejectedConversionRate        None                                            
rejectedConversions          None                                            
rejectedNetCost              Advertisers only                                
returnOnAdSpend              Advertisers only                                
returnOnInvestment            Advertisers only                                
totalCommission              None                                            
totalConversions              None                                            
totalNetCost                  Advertisers only                                
uniqueVisitors                None                                            
validatedCommission          May be restricted based on your account settings
validatedConversionCommissionMay be restricted based on your account settings
validatedConversionCost      Advertisers only                                
validatedConversionRate      None                                            
validatedConversions          None                                            
validatedCost                None                                            
validatedNetCost              Advertisers only                                
validationRate                None                                            

Reporting Dimensions

Dimensions which can be passed to the reporting endpoint. As noted below, some dimensions may be restricted according to your account type or settings.

DimensionRestrictions
adContainerId        None                                            
adContainerName      None                                            
adUnitHeight          None                                            
adUnitId              None                                            
adUnitPath            None                                            
adUnitTypeName        None                                            
adUnitWidth          None                                            
advertiserId          None                                            
advertiserName        None                                            
agencyId              None                                            
campaignCountry      None                                            
campaignGroup        Advertisers only                                
campaignGroupId      None                                            
campaignId            None                                            
campaignName          None                                            
campaignStatus        None                                            
campaignType          Advertisers only                                
campaignTypeId        None                                            
city                  None                                            
countryCode          None                                            
countryName          None                                            
currencyCode          None - Campaign Currency                      
customerType          None                                            
date                  None                                            
dateId                None                                            
dayName              None                                            
deviceType            None                                            
deviceTypeCount      None                                            
hour                  None                                            
invoiceDate          None                                            
invoiceDateId        None                                            
InvoiceDayName        None                                            
invoiceMonth          None                                            
invoiceMonthName      None                                            
invoiceMonthNo        None                                            
invoiceQuarter        None                                            
invoiceWeek          None                                            
invoiceWeekCommencingNone                                            
invoiceYear          None                                            
itemCategory          None                                            
itemPolicyType        None                                            
minute                None                                            
month                None                                            
monthName            None                                            
monthNo              None                                            
operatingSystem      None                                            
partnerType          None                                            
PID                  None                                            
placementDesc        None                                            
placementId          None                                            
placementName        None                                            
placementType        None                                            
primaryVertical      None                                            
primaryVerticalId    None                                            
publisherId          None                                            
publisherName        May be restricted based on your account settings
publisherType        None                                            
quarter              None                                            
quoteAction          None                                            
regionName            None                                            
secondaryVertical    None                                            
secondaryVerticalId  None                                            
trackingType          None                                            
voucherCode          None                                            
websiteName          May be restricted based on your account settings
websiteUrl            May be restricted based on your account settings
week                  None                                            
weekCommencing        None                                            
year                  None                                            

Rate Limits & Quotas

By default all users are restricted to a maximum of 5 requests per minute. In addition, user accounts using excessive resources may have additional rate limiting applied.

If you have a use-case for these limits to be raised please raise a support ticket.