Callback Parameters

🚧

Caution

You can specify your own key name and then choose one of the following values for that key.
You can also add your own static and dynamic parameters by clicking the + button.

ValueTypeDescription
Ad TypeStringType of ad shown (e.g. interstitial, rewarded_video, video_interstitial)
Award AmountStringAmount of currency awarded for completed video view
Bid TypeStringType of Chartboost bid (CPI, CPM); Will return free if campaign is a cross-promotion with direct invoicing
Bid ValueStringValue of the campaign bid; Will return free or an empty string if campaign is a cross-promotion with direct invoicing
Campaign IDStringYour campaign`s ID
Campaign NameStringYour campaign`s name
Campaign TypeStringType of Chartboost campaign (cross-promotion, publishing, or advertising)
Click IDStringUnique ID of the Chartboost click event that triggered the callback - Advertiser only
Completed View IDStringID of a completed view, fired every time a user finishes watching a video. Only included in callbacks set to advertiser role.
Creative ID (advertiser only)StringID of the creative β€” 24-digit alphanumeric, e.g. 5361f8abc26ee43e1c3aafe2
Creative Name (advertiser only)StringName of the creative
Currency NameStringType of currency awarded for completed video view, in 3-letter ISO 4217 currency code format
Custom IDStringStringCustom identifier from the Chartboost SDK, sent in the POST body for Chartboost API server requests after a completed view event; can be used to validate Rewarded Video calls via server instead of within the SDK. SDK 5.0+ only.
Device Country CodeStringCountry code of the device β€” reverse IP lookup or ISO 639-1 (two-letter code)
Device LanguageStringTwo-character ISO 639-1 language codes according to:
-iOS: the preferred system keyboard
-Android: the device language
Device ModelStringCategorical description of device phone (e.g. Nexus 4)
Device OSStringVersion of device`s operating system
Device TypeStringDetailed information on the device model (e.g. LGE Nexus 4)
Event TypeStringDescription of the event type (click, completed view, or converted install)
Format of Click TimestampStringTo append something like time=12:51:01PM 2013-08-04PST to your callback, enter time in the Key field and H:i:sA Y: m:de in the Format field.
Format of TimestampStringTo append something like time=12:51:01PM 2013-08-04PST to your callback, enter time in the Key field and H:i:sA Y: m:de in the Format field.
Formatted IFAStringSame as IFA but with inserted dashes, capitalized. iOS SDK v3.0.7+ only.
ValueTypeDescription
From App IDStringThe publishing app`s Chartboost app ID β€” 24-digit alphanumeric, e.g. 53bc620bc26ee47f7f21fec6
From App NicknameStringThe publishing app`s name, input by developer into the Chartboost dashboard; name that appears in campaign analytics API
From App Official NameStringApp store official name of the publishing app
From Bundle IDStringThe bundle ID for the publishing app; iOS bundle IDs can be found in the games iTunes Connect record and Google Play bundle IDs can be found in the apps Play Store URL.
From Company NameStringPublishing company`s name, entered in Chartboost account
From Store IDStringThe iTunes store ID for the publishing app; this is the 9-digit number found on the app`s App Store listing.
GAIDStringGoogle advertising identifier. Android SDK v4.0+ only. See device identifiers for more information.
IFAStringiOS identifier for advertising without hashing. iOS SDK v3.0.7+ only. See device identifiers for more information.
IP AddressStringIP address of the device that triggered the event (e.g. β€œ10.1.2.3”) - Advertiser only
PlatformStringThe app`s platform β€” iOS, ANDROID, or AMAZON
Side of Event (advertiser/publisher)StringReturns either adevertiser or publisher values
Target NameStringName of Chartboost campaign target
ValueTypeDescription
To App IDStringThe advertising app`s Chartboost app ID β€” 24-digit alphanumeric, e.g. 53bc620bc26ee47f7f21fec6
To App NicknameStringThe advertising app`s name, input by developer into the Chartboost dashboard; name that appears in campaign analytics API
To App Official NameStringApp store official name of the advertising app
To App SignatureStringSignature of the app being advertised β€” 40-digit alphanumeric, e.g. 8f64804162d9c912ff290ec43d9773ef1ba121cd - Advertiser role only
To Bundle IDStringThe bundle ID for the app being advertised; iOS bundle IDs can be found in the games iTunes Connect record and Google Play bundle IDs can be found in the app`s Play Store URL.
To Company NameStringAdvertising company`s name, entered in Chartboost account
To Store IDStringThe iTunes store ID for the app being advertised; this is the 9-digit number found on the app`s App Store listing
User AgentStringMobile web user agent string of the device that triggered a click event, e.g. β€œMozilla/5.0 (iPhone; U; CPU iPhone OS 5_0 like Mac OS X; en-us) AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7A341 Safari/528.16” - Advertiser only
User IDStringYour Chartboost user ID β€” 24-digit alphanumeric, e.g. 50c8cc5516ba47d406000016
UUIDStringDevice ID without hashing:
-Legacy Android ID for Android OS
-Legacy Android ID for Amazon OS
-See device identifiers for more information.

Accepted PHP Timestamp Formats & Ranges

Timestamp FormatDescription
DWeekday as locale abbreviated name
lWeekday as locale full name
MMonth as locale abbreviated name
FMonth as locale full name
dDay of the month as a decimal number [01,31]
HHour (24-hour clock) as a decimal number [00,23]
hHour (12-hour clock) as a decimal number [01,12]
zDay of the year as a decimal number [001,366]; range is [000,365] in PHP but will still validate 364 days a year
mMonth as a decimal number [01,12]
iMinute as a decimal number [00,59]
aLocale equivalent of either AM or PM; this is lowercase in PHP and uppercase in Python
ALocale equivalent of either AM or PM
sSecond as a decimal number [00,61]
wWeekday as a decimal number [0,6]; 0 = Sunday
WWeek number of the year, Monday as the first day of the week
yYear without century as a decimal number [00,99]
YYear with century as a decimal number (e.g. 2016)
0UTC offset in the form +HHMM or -HHMM
TTime zone name; empty string if the object is native
eTime zone name; empty string if the object is native
UUnix time