We're moving to the new documentation portal: developers.bidmachine.io
Documentation
Log In
Documentation

Contextual data collected by BM SDK

User Contextual Data

Name

Type

Description

Example

request.user.ext.impdepth

int

The count of impressions for a specific placement type in a given app session

5

request.user.ext.sessionduration

long

The total duration of time a user has spent so far in a specific app session expressed in seconds

55

request.user.ext.lastbundle

string

The last app bundle the user saw on the previous impression in a given session per placement type

"bundle"

request.user.ext.lastadomain

string

The last advertiser domain the user saw on the previous impression in a given session per placement type

"domain"

request.user.ext.clickrate

int

The percentage of clicks/impressions per user per placement type over a given number of impressions, where 5 represents a 5% CTRT
This only applies to Rewarded and Video placement types

5

request.user.ext.lastclick

int

An integer value indicating if the user clicked on the last impression in a given session per placement type, where "1" = user clicked, "0" - user didn't click

1

request.user.ext.completionrate

int

he percentage of successful completions/impressions for a user per placement type for a given number of impressions, where 70 represents a 70% completion rate.

70

Device Contextual Data

Name

Type

Description

Example

request.device.ext.inputlanguage

list[string]

list of user languages

["EU", "US"]

request.device.ext.diskspace

int

freeDiskSpaceBytes / (1024 * 1024)

231022 MB

request.device.ext.totaldisk

int

totalDiskSpaceBytes / (1024 * 1024)

471482 MB

request.device.ext.ringmute

int

request.device.ext.charging

int (1/0)

is the device charging

1 - yes
0 - no

request.device.ext.headset

int (1/0)

is the device headset connected

1 - yes
0- no

request.device.ext.batterylevel

float

battery level

1 - full charges


0.1 - 10 %


0 - empty

request.device.ext.batterysaver

int (1/0)

enabled battery saver or not

1 - yes
0 - no

request.device.ext.darkmode

int (1/0)

enabled dark mode or not

1 - yes
0 - no

request.device.ext.airplane

int (1/0)

enabled airplan mode or not

1 - yes
0 - no

request.device.ext.dnd

int

request.device.ext.devicename

string

User given name of device

iPhone 14 Pro

request.device.ext.time

float

Current time ISO 1970 sec

1680197719.5890589

request.device.ext.screenbright

double

Current scrin bright

0...1

request.device.ext.jailbreak

int (1/0)

Is Jail broken

1 - yes
0- no

request.device.ext.lastbootup

double

Boot date with secodns accuracy ISO 1970

1676623341.589673

request.device.ext.access

string

Acessability [isShakeToUndoEnabled,isReduceMotionEnabled, isDarkerSystemColorsEnabled, isReduceTransparencyEnabled ]

[0,1,1,1]

request.device.ext.headsetname

string

Name of headset

Speaker

request.device.ext.totalmem

long

Total RAM in bytes

34359738368 B

request.device.ext.atts

int

trackingAuthorizationStatus

0 - STKAdAuthorizationStatusNotDetermined
1 - STKAdAuthorizationStatusRestricted
2 - STKAdAuthorizationStatusDenied
3 - STKAdAuthorizationStatusAuthorized