The Remerge Event Tracking API is a Remerge tool that offers its clients and partners a method of transferring a wide range of data to Remerge. Accordingly, said clients/partners may provide us with their In-App Event, Attribution, BI, or SKAdNetwork data. The following document provides insight into In-App Event data forwarding to the Remerge Event Tracking API. In case of any questions, please reach out to your Remerge Account Manager.
Process
Request
GET
Response
HTTP 204 (by default). Therefore, reach out to your Remerge Account Manager to ensure your request's success.
Endpoint
Protocol
HTTPS
Frequency
General
- Forward all of your in-app events in real time.
App Open
- Forward your App Open events every 10 minutes.
Parameters
- Provide ALL MANDATORY (M) parameters to ensure proper tracking.
- Add (optional) parameters to improve retargeting and reporting.
- Properly encode parameters that contain characters that are NOT web-safe.
| Name | Content | Examples |
|---|---|---|
| app_id (M) | Google Play Store/iTunes ("ID" prefix not included) | 553834731, com.king.candycrush |
| event (M) |
The in-app event name should reflect its nature/CTA (e.g., in-app open or in-app purchase). Also, ensure to name your first App Open event (on behalf of a new user) an Install event. |
purchase, add_to_basket, level_2_reached |
| data | Additional data on the event. Ensure to implement the JSON format and double quotation marks. A single string is also acceptable | {"store":1341, "keywords":["yellow","red"]} |
| ts | Event timestamp as Unix Epoch. The timezone should be in UTC and 10 digits long | 1427976389 |
| partner (M) | Tracking partner name | supergame |
| key (M) | Partner's key (provided by Remerge) | x34dlx |
| idfa (M) |
Apple IDFA (ensure the uppercasing of all letters) |
AEBE52E7-03EE-455A-B3C4-E57283966239 |
| aaid (M) |
Android Advertising ID (ensure the lowercasing of all letters) |
38400000-8cf0-11bd-b23e-10b96e40000d |
| country | ISO alpha 2 country code | DE |
| device_name | Device name | e.g., iPhone11, iPhone7, iPhone XR, Galaxya51, Galaxya50 |
|
os_name |
OS name | android, ios |
| os_version | OS version | 8.0.1 |
| app_version | App version | 1.2 |
| user | Customer user ID | 4838131 |
| revenue | Revenue in micro currency units (which enables sub-cent values and prevents float issues) | revenue=170000 (=0.17), 5750000 (=5.75$) |
| (revenue_float) | In case your prices do not contain sub-cent values and a decimal separator | revenue_float=0.17 or 5.75 |
| currency | ISO 4217 currency code | USD |
| non_app_event | In case the event is not created by the app (i.e., a click postback) - true or false | false |
|
idfv (M) |
The IDFV (Vendor ID) of your user, applicable to iOS ONLY |
E29738C9-0556-4F49-AB98-1A33197F0FFD |
|
operator |
The mobile operator/the device carrier |
MTS%20RUS, TELCEL, Telenor AT%26T, Iliad, Viettel, LGU%2B |
|
zipcode |
Regional zipcode |
15414, 500064, 517504, 115088 |
|
city |
City name. Use UN/LOCODE for standardization |
Yokohama, Yocsina, Bogota |
|
country_subdivision |
State names |
CA, PB, Sindh, Istanbul |
|
partner_device_id |
Your ID for the user |
|
|
ip |
The IP address (ip4,ip6?) |
178.151.153.17 |
|
language |
User language (can be simple/extended) |
Simple: en,ja,bg Extended: pl-SE, ru_RU |
|
sdk |
Your SDK version, implemented by the client |
2.2 |
The Data Parameter
The data parameter can hold several unique key-value pairs in a JSON format, utilized to provide additional metadata on the user's actions as part of the event itself. For instance, in e-Commerce, this parameter is employed to forward product-related information (e.g., product IDs, prices, or quantity) to display and identify additional relevant products in customized banners from a product feed.
Structure
- The JSON data structure may look as follows:
data={"product_id":"sdf235235dfw3131","cv_type":0}
Format
- Forward to Remerge an URL-encoded JSON object:
data=%7B%22product_id%22%3A%22sdf235235dfw3131%22%2C%22cv_type%22%3A0%7D%20 - Ensure strings are Double-Quoted (as per the JSON specification, https://www.json.org/json-en.html).
- To provide us with Multiple Product IDs, you may do the following:
data={"products":["23ef23","234fe2d","23dw334"]}and encoded:
data=%7B%22products%22%3A%5B%2223ef23%22%2C%22234fe2d%22%2C%2223dw334%22%5D%7D%C2%A0
Example
- An Example with Placeholders ({PLACEHOLDER} should contain the name of your internal placeholder):
https://remerge.events/event?app_id={AppId}&event={EventName}&partner=yourname&key=yourkey&idfa={IDFA}&aaid={AAID}&country={Country}&device_name={DeviceName}&os_name={OS}&os_version={OSVersion}&ts={Timestamp}&revenue={RevenueAmount}¤cy={Currency}&non_app_event=false