🔥 Full Tenjin access for $200/month — all features, no add‑ons, cancel anytime. See pricing & features

Sign Up
View Categories

Impression-Level Revenue Data API (S2S)

6 min read

View as Markdown

This endpoint should only be used when sending Impression-Level Revenue Data (ILRD) directly via S2S for a mediation provider that is not yet officially integrated with Tenjin.

Authentication #

We authenticate every request sent to the Tenjin server using the API Key as the username in basic auth or as a parameter api_key. 

Generic Endpoint #

Path: https://track.tenjin.com/v0/ad_impressions/

Method: POST

Content-Type: application/x-www-form-urlencoded

Device Information Parameters #

Parameters with * are required

ParametersExampleDescription
bundle_id*com.tenjin.wordfinderBundle ID of the app.
advertising_id*be277924-d076-456d-9a20-3c8dee5663d3The raw advertising ID of the device. Please note that the request will only be accepted with a valid device id (any of advertising_id, developer_device_id, and analytics_installation_id). It’s important to stay consistent in sending the device id types.
For iOS, it should be IDFA. In the case of no user consent, advertising_id can be empty or all zeros, and IDFV needs to be provided in developer_device_id along with analytics_installation_id
For Android, either advertising_id or analytics_installation_id should be provided.
developer_device_id*5f4dcc3b-5aa5-40e1-8914-7a9c5d5ebf31Alternative field for device unique identifier, used when there is no advertising id.For iOS, it should be IDFV.
analytics_installation_id*91d1c313-dd94-4bd3-bbbb-16c8b7afa054Tenjin generated Application Install-specific identifier.Available by customer callback or SDK.Android SDKiOS SDKUnity SDK
platform*iosPlatform of the app. ios,android (with Google Play Store), android_other (with no Google Play Store, e.g. devices with Chinese app stores), amazon (with Amazon App Store)
app_version*1.5The version of your app
For Android:
String app_version = context.getPackageManager().getPackageInfo(context.getPackageName(), 0).versionName + “.” + context.getPackageManager().getPackageInfo(context.getPackageName(), 0).versionCode)
For iOS:
[[[NSBundle mainBundle] infoDictionary] objectForKey:@”CFBundleShortVersionString”]
app_version_code2Android only
Android App Version: https://developer.android.com/studio/publish/versioning
build_idRQ3A.211001.001For Android: 
String build = String.valueOf(Build.ID)
For iOS: 
@import Darwin.sys.sysctl;
NSString *build(void) {  size_t bufferSize = 64;  NSMutableData *buffer =    [[NSMutableData alloc]      initWithLength:bufferSize];  int status =    sysctlbyname(“kern.osversion”,      buffer.mutableBytes,      &bufferSize, NULL, 0);  if (status != 0) {    return nil;  }  return [[NSString alloc]    initWithCString:buffer.mutableBytes    encoding:NSUTF8StringEncoding];}
carrierT-2Mobile Carrier (Internet Service Provider)
connection_typewifimobile/wifi
countryUSThe ISO locale country codes standard (see Apple documentation for example).
devicebluelineAndroid: android.os.Build.DEVICE (reference)iOS: systemInfo.machine (reference)
device_brandgoogle
device_manufacturerGoogle
device_modelPixel 3For Android:
String device = Build.MODEL;
For iOS:
@import Darwin.sys.sysctl;
NSString *device(void) {  size_t bufferSize = 64;  NSMutableData *buffer =    [[NSMutableData alloc]      initWithLength:bufferSize];  int status =    sysctlbyname(“hw.machine”,      buffer.mutableBytes,      &bufferSize, NULL, 0);  if (status != 0) {    return nil;  }  return [[NSString alloc]    initWithCString:buffer.mutableBytes    encoding:NSUTF8StringEncoding];}
device_productbluelineAndroid only: build.PRODUCT
languageenTwo-letter ISO 639‑1 Code
limit_ad_trackingFALSEDevice limits ad tracking? (true, false)
opt_inTRUEDevice Opt-in consent for GDPR compliance: Tenjin SDK implementation
localeen_USFor Android:String locale = Locale.getDefault().toString()
For iOS:[[NSLocale currentLocale] localeIdentifier]
os_version14For Android: String.valueOf(Build.VERSION.SDK_INT)
For iOS: [[UIDevice currentDevice] systemVersion]
os_version_release14.3.1For Android only: full os release version
timezoneEurope/Ljubljana
user_agentLinux; U; Android 11; SM-A505FN Build/RP1A.200720.012User agent of user’s device
screen_height2028
screen_width1080
sent_at1693581566830Epoch time in milliseconds
session_idf4239af1-cd6f-49e8-8b97-f61a9e81a7e0
source_app_storegoogleplayAndroid only: unspecified, googleplay, amazon, other
ip_address* (Required to determine device country)87.123.246.9The User’s IP Address.  This is used to look up countries for Google DMA user consent parameters.
ad_user_data (Required by Google)1Google User Consent Signal Parameter: consent of 3P transmission of user level data for ads1 for consent granted0 for consent deniedRemove the parameter entirely from the request (do not set blank) when there is no user consent data
ad_personalization (Required by Google)1Google User Consent Signal Parameter: consent of personalized ads1 for consent granted0 for consent deniedRemove the parameter entirely from the request (do not set blank) when there is no user consent data

Revenue Information Parameters #

Parameters with * are required

ParametersExampleDescription
ad_revenue_mediation*maxMediation platform name, please use values below,:
max,ironsource,admob,topon,cas,tradplus
For other mediation, use custom.
network_name*mintegralNetwork name that display the ad, usually passed by the mediation provider
currency*USDThe ISO currency codes, e.g. USD, JPY
revenue_decimal*0.001Revenue in decimal for ONE impressiononly require either revenue_decimal or revenue_cpmWhen receive both, revenue_decimal will be prioritized
revenue_cpm1.0Revenue in CPM, equals to revenue_decimal * 1,000
mediation_countryUSCountry from mediation provider, in the ISO two-letter country codes e.g. US
ad_unit_id09807a44b2f855ccAd unit ID reported by the winning network
ad_formatbannerFormat of the ad unit: banner, mrec, xpromo, native, leaderboard/leader, interstitial/inter, rewarded/reward, rewarded_inter/rewarded_interstitial
precisionBIDValue passed by mediation, indicates the source of the revenue, like BID, CPM, RATE
creative_id9299584Value passed by mediation,
placementBanner123Value passed by mediation for publisher-defined ad placement name
network_placementBanner_namePlacement name of the external Ad Network
auction_id27d38ef0-847c-11ec-8b8d-3fe5d30476ca_765960010Value passed by mediation

Request Example #

JSON
curl -X POST https://track.tenjin.com/v0/ad_impressions/ -H "Content-Type: application/x-www-form-urlencoded" -d 'api_key=api_key&advertising_id=123&ad_revenue_mediation=max&network_name=google&mediation_country=US&currency=USD&ad_unit_id=1&ad_format=banner&revenue_decimal=0.01&precision=BID&creative_id=2&placement=banner_1&auction_id=3&bundle_id=com.tenjin.test&platform=ios&ad_user_data=1&ad_personalization=1'
What are your Feelings
anurag
Impression-Level Revenue Data API (S2S) | Tenjin
Learn how to implement Tenjin's Impression-Level Revenue Data API with server-to-server integrations for accurate ad revenue tracking.
Home
Docs
Impression-Level Revenue Data API (S2S)
Tenjin
Growth Made Simple