Skip to main content

Ad Revenue Attribution

**Last version in PDF: Ad Revenue AttributionDocs.pdf (For May 23rd, 2019)
**

General info

Ad Revenue attribution API is available for our customers and can be enabled on request. Appodeal will decide regarding the enabling of this API.

After enabling it is very easy to start working with API: Appodeal will automatically generate a set of daily files including the information described below.

All files are created automatically and are stored for 7 days.

You should use your API key and user ID at https://app.appodeal.com/profile/api_credentials and use these credentials in every API call.

There is only one endpoint that can be used to get a list of available files.

Example of the request:

https://api-services.appodeal.com/api/v2/get_log_urls?api_key={your api key}&user_id={your user id}

The result is (in case there are files available):

{
log_files: [
"https://appodeal-ad-rev-attribution.s3.amazonaws.com/for_{your user id}/2017_10_04_clicks_116bc9d7e45906241a6a4.csv",
"https://appodeal-ad-rev-attribution.s3.amazonaws.com/for_{your user id}/2017_10_04_impressions_f7d8ec46adbef8442469e.csv",
"https://appodeal-ad-rev-attribution.s3.amazonaws.com/for_{your user id}/2017_10_05_clicks_fd310ab6ceac36a7f9edb.csv",
"https://appodeal-ad-rev-attribution.s3.amazonaws.com/for_{your user id}/2017_10_05_impressions_cf09dae6ba0d8efb64a26.csv",
"https://appodeal-ad-rev-attribution.s3.amazonaws.com/for_{your user id}/2017_10_06_clicks_f5de438b44378d6143118.csv",
"https://appodeal-ad-rev-attribution.s3.amazonaws.com/for_{your user id}/2017_10_06_impressions_3d939797c3bf301921e62.csv",
"https://appodeal-ad-rev-attribution.s3.amazonaws.com/for_{your user id}/2017_10_07_clicks_11135427a1befd9ce7583.csv",
"https://appodeal-ad-rev-attribution.s3.amazonaws.com/for_{your user id}/2017_10_07_impressions_66795a3cfef15031e7658.csv",
"https://appodeal-ad-rev-attribution.s3.amazonaws.com/for_{your user id}/2017_10_08_clicks_87dde4827d94498e306e1.csv",
"https://appodeal-ad-rev-attribution.s3.amazonaws.com/for_{your user id}/2017_10_08_impressions_4e22c7d6f974cb94a5ab1.csv"
],

status: 200,

message: "success"
}

URL format:

https://appodeal-ad-rev-attribution.s3.amazonaws.com/for\_{your user id}/{log date with underscore}\_{clicks or impressions log}\_{dynamic unique hash}.csv
  • {your user id} - id of the user
  • {log date with underscore} - a date for which the data is presented
  • {clicks or impressions log} - [clicks|impressions] - shows what is contained in  the file
  • {dynamic unique hash} - the unique hash

Request to get the list of demo log files:

https://api-services.appodeal.com/api/v2/demo_log_files_urls?api_key={your api key}&user_id={your user id}
info

The data in output files have 5 days delay. The first data will appear only after 5 days from the time the API was enabled!

CSV files format

Every file that can be downloaded contains the following information separated with tabulation:

FieldDescriptionType
timestamprecord unix timestampinteger
ad_typead type
interstitial = 1, video = 2, banner = 3, native = 4, mrec = 5, rewarded_video = 6
integer
modeldevice modelstring
platformplatform ID
GOOGLE = 1, AMAZON = 2, IOS = 4, TVOS = 5
integer
ipIP addressstring
devicedevice IDstring
countryCountry codestring
appapplication keystring
os_versiondevice OS versionstring
sdksdk versionstring
genderdevice user genderstring
agedevice user agestring
relationdevice user relationstring
addressdevice user addressstring
tztimezonestring
latlatitudedecimal
lonlongtitudedecimal
connectiondevice connection to the internetstring
batterybattery levelstring
kinddevice kindstring
educationdevice user educationstring
kidsdevice user kidsstring
networkad network namestring
package_versionapplication package versionstring
revenuerevenuedecimal
total_session_impressionsTotal impressions from all ad types for session,
only sent if ad_type is 2 or 6, otherwise 0
integer
total_session_clicksTotal clicks from all ad types for sessioninteger
total_session_viewsTotal full video views from all ad types for sessioninteger
session_impressionsImpressions for ad_type for sessioninteger
session_clicksClicks for ad_type for sessioninteger
session_viewsFull video views for ad_type for session,
only sent if ad_type is 2 or 6, otherwise 0
integer
session_idcurrent sesssionstring
hashed_waterfallmd5 hash of created waterfall (as long as we can, e.g. 256 bytes)string
install_timetimestamp for the first openbigint
ad_stats_show_count(session impressions)integer

Country Codes

IdCodeNameIdCodeNameIdCodeName
1THThailand81QAQatar161DZAlgeria
2JPJapan82KWKuwait162GNGuinea
3CNChina83GPGuadeloupe163CDCongo
4AUAustralia84MQMartinique164SZSwaziland
5INIndia85GFFrench Guiana165BFBurkina Faso
6MYMalaysia86EGEgypt166SLSierra Leone
7KRSouth Korea87DODominican Republic167SOSomalia
8TWTaiwan88GUGuam168NENiger
9HKHong Kong89PRPuerto Rico169CFCentral African Republic
10PHPhilippines90VIU.S. Virgin Islands170TGTogo
11VNVietnam91NZNew Zealand171BIBurundi
12FRFrance92SGSingapore172GQEquatorial Guinea
13DEGermany93IDIndonesia173SSSouth Sudan
14ILIsrael94NPNepal174SNSenegal
15SESweden95PGPapua New Guinea175MRMauritania
16ITItaly96PKPakistan176DJDjibouti
17NLNetherlands97PAPanama177KMComoros
18GRGreece98CRCosta Rica178TNTunisia
19ESSpain99BBBarbados179BTBhutan
20ATAustria100BSBahamas180UYUruguay
21GBUnited Kingdom101LCSaint Lucia181GLGreenland
22BEBelgium102ARArgentina182XKKosovo
23AEUnited Arab Emirates103BDBangladesh183KYCayman Islands
24RURussia104TKTokelau184JMJamaica
25KZKazakhstan105MOMacao185GTGuatemala
26DKDenmark106KHCambodia186MHMarshall Islands
27PTPortugal107MVMaldives187AWAruba
28SASaudi Arabia108NCNew Caledonia188MCMonaco
29SISlovenia109FJFiji189AIAnguilla
30IRIran110MNMongolia190GDGrenada
31NONorway111WFWallis and Futuna191PYParaguay
32USUnited States112ALAlbania192MSMontserrat
33MXMexico113UZUzbekistan193TCTurks and Caicos Islands
34CACanada114MEMontenegro194AGAntigua and Barbuda
35SYSyria115BZBelize195TVTuvalu
36UAUkraine116KPNorth Korea196PFFrench Polynesia
37CYCyprus117VAVatican City197SBSolomon Islands
38CZCzech Republic118AQAntarctica198VUVanuatu
39CHSwitzerland119PEPeru199SRSuriname
40IQIraq120BMBermuda200CKCook Islands
41RORomania121CWCuraçao201KIKiribati
42TRTurkey122COColombia202NUNiue
43LBLebanon123VEVenezuela203TOTonga
44HUHungary124ECEcuador204TFFrench Southern Territories
45GEGeorgia125ZASouth Africa205NFNorfolk Island
46AFAfghanistan126KNSaint Kitts and Nevis206BNBrunei
47BRBrazil127WSSamoa207TMTurkmenistan
48AZAzerbaijan128BOBolivia208PNPitcairn Islands
49PSPalestine129GGGuernsey209SMSan Marino
50LTLithuania130MTMalta210AXÅland
51OMOman131TJTajikistan211FOFaroe Islands
52RSSerbia132SCSeychelles212SJSvalbard and Jan Mayen
53SKSlovakia133BHBahrain213CCCocos [Keeling] Islands
54FIFinland134NGNigeria214NRNauru
55ISIceland135ZWZimbabwe215GSSouth Georgia and the South Sandwich Islands
56MDRepublic of Moldova136LRLiberia216UMU.S. Minor Outlying Islands
57BGBulgaria137GHGhana217SXSint Maarten
58MKMacedonia138TZTanzania218GWGuinea-Bissau
59LILiechtenstein139ZMZambia219MFSaint Martin
60JEJersey140NANamibia220VCSaint Vincent and the Grenadines
61PLPoland141MGMadagascar221PMSaint Pierre and Miquelon
62HRCroatia142AOAngola222BLSaint-Barthélemy
63BABosnia and Herzegovina143CIIvory Coast223DMDominica
64EEEstonia144SDSudan224STSão Tomé and Príncipe
65LVLatvia145UGUganda225FKFalkland Islands
66JOJordan146CMCameroon226MPNorthern Mariana Islands
67KGKyrgyzstan147MWMalawi227TLEast Timor
68RERéunion148GAGabon228BQBonaire
69YTMayotte149MLMali229FMFederated States of Micronesia
70IEIreland150BJBenin230PWPalau
71IMIsle of Man151TDChad231GYGuyana
72LYLibya152BWBotswana232HNHonduras
73LULuxembourg153CVCape Verde233NINicaragua
74AMArmenia154RWRwanda234SVEl Salvador
75VGBritish Virgin Islands155CGRepublic of the Congo235ADAndorra
76YEYemen156MZMozambique236MMMyanmar [Burma]
77BYBelarus157GMGambia237LKSri Lanka
78GIGibraltar158LSLesotho238HTHaiti
79KEKenya159MUMauritius
80CLChile160MAMorocco