What parameters can I add to the callback URL definition?
The parameters are listed in the table below. You can choose any of these parameters and add them as macros to your URL, allowing Metrix to send them to your server in the callback:
| Parameter | Type | Description | Example | Install | Reinstall | Deletion | Fraud | Event | Click |
|---|---|---|---|---|---|---|---|---|---|
tracker_code | String | Tracker Identifier | bdjulq | ✔ | ✔ | ✔ | ✔ | ✖ | ✔ |
network_name | String | Advertising Network Name | AdNetwork1 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
campaign_name | String | Campaign Name | Black Friday | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
adgroup_name | String | Ad Group Name | Video Banner | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
creative_name | String | Creative Name | Product Features | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
sub_id | String | Sub-ID | 83407c9a-392d-4f6b-b689-eadfe557ff18, abcdefg | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
action_name | String | Type of Action (e.g., install, event, click, fraud) | fraud | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
reinstalled | Boolean | Indicates if it’s a reinstall | true, false | ✔ | ✔ | ✖ | ✖ | ✖ | ✖ |
rejection_reason | String | Fraud Rejection Reason | anonymousIP, tooManyEngagements, clickInjection | ✖ | ✖ | ✖ | ✔ | ✖ | ✖ |
event_slug | String | Event Identifier | uimgx | ✖ | ✖ | ✖ | ✖ | ✔ | ✖ |
app_name | String | App Package Name | com.example.test | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
app_version | String | App Version | 1.1.2.Beta | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
device_name | String | Device Model | sm-a505f | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
device_brand | String | Device Brand | xiaomi | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
device_manufacturer | String | Device Manufacturer | xiaomi | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
android_id | String | Android Device ID | b9da30111528c740 | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
gps_adid | String | Google Advertising ID | 38400000-8cf0-11bd-b23e-10b96e40000d | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
ip_address | String | User’s IP Address | 91.251.150.188 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
user_agent | String | User Agent String | Dalvik/2.1.0 (Linux; U; Android 10; JSN-L22 Build/HONORJSN-L22) | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
metrix_user_id | String | Metrix User ID | c0bcf71e-a027-4cfa-974a-e90e040e5c3a | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
created_at | Timestamp | Creation Time (ms) | 1403674212 | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
clicked_at | Timestamp | Click Time (ms) | 1403568849 | ✔ | ✔ | ✔ | ✔ | ✖ | ✔ |
installed_at | Timestamp | Install Time (ms) | 1404214634 | ✔ | ✔ | ✔ | ✔ | ✔ | ✖ |
city | String | User’s City | Tehran | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
country | String | User’s Country | IRN | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
Note: Metrix supports parameters in both camelCase and snake_case.
Additionally, if you have a custom parameter that is populated by you during the click and you need it returned to you at the time of installation or another event, you can include it as a placeholder in your callback link.
A sample installation callback might look like this:
http://callbacks.myserver.com/path?clicked_at={clicked_at}&tracker_code={tracker_code}&ip_address={ip_address}Additionally, parameters set by you within the SDK can be sent to your server.
Last updated on