Important note:

This feature will be deprecated on September 30th 2022. You can start using our new Raw data API as a replacement

Data dumps are the best way to get all the data from SOOMLA into your BI platform. There are multiple types of data dumps in different granularity levels designed to fit different use cases.

Supported storage infrastructures

• AWS S3
• Google Cloud Storage

File format:

As default we will generate JSON files, however, you can ask for CSV format(with or without headers) - for that please contact Soomla CS team.

As default the files will be delivered uncompressed, you can ask to get then compressed by GZIP.  

In Cases where the dumps exceed the bucket limit, please contact our the support team to set up a splitting process before sending the dumps

Types of Data Dumps

User Level

The user level data dump provides an aggregated user level look at all the data for a specific day. The data is broken down by user, date, platform, network, ad type, and country.

Advertiser Level

The advertiser level report provides data on the advertiser level inside your app. This data is broken down by ad title, day, platform, country, network and ad type.

App Level

The app level report provides an aggregated look at the data in your app. This data is broken down by day, platform, country, network and ad type.
Note:
We send this report twice a day - first time without PST data at 8:00 UTC, then we send it again including PST data at 10:00(same file name and same location)

User and Advertiser

The user and advertiser level report provides an aggregated look at user level data in your app per advertiser they have seen. This data is broken down by user, advertiser, country, ad network, and ad type.

User and Advertiser Clicks

The user and advertiser clicks level report provides an aggregated look at the advertisers a user has clicked on in your app. This data is broken down by user, advertiser, country, ad network, ad type, and click.

Waterfall Stats

The user and advertiser clicks level report provides an aggregated look at revenue generated by each impression number in your app. This data is broken down by impression number, date, platform, country, ad network, and ad type.

Impression Level

The impression level report provides all the data for each impression in your app to provide a granular look at user activity. This data is broken down to a very granular level with all the information SOOMLA has on each impression provided.

Active User Level

The active user level data dump includes all users that were active on the app, including users who did not have any impressions and who did not generate any revenue.

Supported fields - Default

Supported fields - Optional

Fields Description 

Impressions - Number of times a user has seen an ad

Revenue - Amount of revenue generated

Clicks - Number of times a user clicks

User ID - Unique user level identification

Device ID - IDFA (Identification for advertisers)

Activity Date - The date when the activity took place

Day - Date of the aggregated activity

Platform - IOS or Android

Country - Country where the action took place

Ad Network - Network that displayed the ad where the action was taken

Ad Type - Name of the ad type

key legend for ad_types:

-1 - unknown
0 - Rich Media
1 - Interstitial
2 - App Wall
3 - Video
4 - Rewarded video
5 - Native
6 - Banner
7 - Offer wall
8 - Native HTML
9 - External
10 - Rewarded
11 - Interactive

Title - Name of the advertiser

Category - App category of the advertiser from the app store

Advid - Identifier of the advertiser. In case the advertiser is a domain, this field will hold the domain of the advertiser.

URL - app store url

Advit - Type of Advid ID given as a numerical value (at imp_all report - this field will present numerical value as default, however you can ask CS team to provide an explicit values instead)  

TS - Unix Timestamp of when the action took place, either impression or click. This will be the same as the time stamp for the click, impression, or other action that took place

Imp Num - Impression number in the sequence of a user, if it is the first impression a user has made it would be 1 and so on. For banners and native the value of imp num is not calculated so imp_num = -1.

App Key - Unique application identifier from SOOMLA

Revenue TS - Unix Timestamp of when the revenue was generated, will be the same as the time stamp of the action that caused the revenue

Click TS - Unix Timestamp of the click 

Video Completed TS - Unix Timestamp of when the video was completed

Version - App version

App Package - Package Name

Placement - Placement identifier 

Install Day - Date the user installed

First Day - The first day Soomla registered the user using the app

Traffic Source - Source of the users install

ad_types_names - Add type names

extra_uid - Extra user id from the SDK

upload_date - the date of uploading the file 

install_ts - Unix Timestamp of install app after impression

click_score - the click score (can be 0 or 1)

custom_data - publisher custom data that sent using the SDK (JSON object)

Revenue models - The report will include these additional columns:

1. rev_cpm_deal
2. rev_imp_avg
3. rev_i_score
4. rev_i_score_day
5. rev_i_avg
6. rev_i_avg_day
7. rev_vc_avg
8. rev_vc_score
9. rev_clk_avg
10. rev_clk_score
11. rev_t_clk_score
12. rev_t_clk_avg

creative - provides with the creative details on key value pair, includes the following keys:
creative_type, video_urls , end_card_urls, image_urls, icon_urls, source_urls
example:

"creative": {
 "creative_type": "video",
 "video_urls": [
 "https://www.youtube.com/watch?v=AUsP-d4"
 ],
 "end_card_urls": [
 "https://lh3.googleusercontent.com/E9I4vh6U6Hc2fOX5nX2_7LH_I576-LtzL6KbRdMTb6pVsdWNeh_ZhmfbYSSjDn4Q=rw-v2",
 "https://lh3.googleusercontent.com/gJ2_7DCknQQ97ukQDakLQ9bW_u0pG7ycCVbD5A677EfJFlYFQceZiK_f5aZpCKLRABk=rw-v2",
 "https://lh3.googleusercontent.com/BEJbqXrw73uUAkjHhAY7lGwumzwttr7xo5WonTqBnmDBMbJixVNAid1IpHDWcg6Kc7w=rw-v2",
 "https://lh3.googleusercontent.com/pZEp5YGiuBBxBp4rnIMrsn1OzvAFx0nsGqX5-fPAsyjrXOjJ2GTmyT-bmp_uS9_fnW18=rw-v2"
 ],
 "image_urls": [
 "https://lh3.googleusercontent.com/xwphCxXlzI_B-r1kMk2kAgQ_24-vGpKm0KgwY_wNe_fh4NYms4RHEOrW0Q97pIPHCN2jw=w215-h215-rw"
 ],
 "icon_urls": [],
 "source_urls": []}, 

sdk_version -Add ad network SDK version
Limitations:

1. The supported ad types are: Interstitial, rewarded Videos, Video
2. In general, ad network SDK version format should be d.d.d / d.d.d.d (i.e 12.23.4 / 12.23.34.4)   
3. For following Android ad networks, SDK version format will be represented as follows:
   
   
   • AdMob - afma-sdk-a-v201604999.201004000.1 (We currently don't have a way to get the version for Admob SDK)
   • AmazonAds - amznAdSDK-android-5.9.0 (version - 5.9.0)
   • Flurry - Flurry_Android_315_12.4.0 (version - 12.4.0)
   • Millennial - 6.4.0-0220c20 (version - 6.4.0)
   • Mintegral - MAL_13.1.11 (version - 13.1.11)
   • Ogury - 3.3.4-moat (version - 3.3.4)
   • Vungle - VungleDroid\/6.7.0 (version - 6.7.0)
     
     
4.  For following iOS ad networks, SDK version format will be represented as follows:
   
   
   • Admob - afma-sdk-i-v7.55.1 (version - 7.55.1)
   • AmazonAds - amznAdSDK-ios-3.0.0 (version - 3.0.0)
   • Flurry - Flurry_iOS_258_10.0.2 (version - 10.0.2)
   • Millennial - 6.8.2-e 85778a9 (version - 6.8.2)Mintegral - MI_6.3.3 (version - 6.3.3)
   • HyprMx - could be (4.5.0 / ENABLED)(For Some of HyprMx SDK version we currently don't have a way to get the version and so we will send ENABLED)

Alt_device_id - Alternative Device ID is the IDFV id (since On IOS 14 the IDFA blocked) 

Device model - user device 

OS version - user OS version

US State - state code which impression happend