AppLovin Event API Reference

The AppLovin Event API destination is currently in Early Access. Please contact [email protected] for more information about this integration.

Destination Info

• Supports Track calls

• Supports HIPAA mode

• Refer to this destination as AppLovin in the Integrations object

• Connection Modes:

	Client-side	Server-side
Web
Mobile
Server

This is a reference document for the AppLovin destination. For information on how to set up this integration, see the AppLovin Event API Quick Start Guide.

Events

When you send an event to the AppLovin Event API destination from Freshpaint, Freshpaint will create an event in the AppLovin event manager by hitting AppLovin's API.

Event Properties

Freshpaint property	AppLovin parameter	Type	Requirement	Description
$aleid	aleid	string	Required	The clickID of the event, from the ?aleid query parameter.
applovin_event_name	name	string	Required	The AppLovin event name to track. *See below Events Reference for all values. Note: If this property is absent, Freshpaint will attempt to use the name of the Freshpaint event. This will only work if the Freshpaint event name is one of the specific supported AppLovin names, so we recommend sending event name separately.
$time	event_time	number	Required	The current Unix epoch time in milliseconds. Freshpaint will autofill this value if missing.
dedupe_id	dedupe_id	string	Required	Unique identifier for the event, used for deduplication. Freshpaint will autofill this value if dedupe_id is not explicitly provided.
event_source_url	event_source_url	string	Required	The URL where the event occurred, must start with "http://" or "https://". Freshpaint will use the Freshpaint SDK's built in $current_url with the full URL redacted if event_source_url is not provided.
$ip	client_ip_address	string	Required	The IP address of the user from the browser where the event was performed. Freshpaint will use the Freshpaint SDK's built in $ip value from the browser event.

Events Reference

The AppLovin / Axon Event API has a number of specific event types and corresponding values required for each of those event types. You can view the full list of details in their documentation.

Valid Event Names:

• add_to_cart

• add_payment_info

• begin_checkout

• generate_lead

• login

• purchase

• page_view

• remove_from_cart

• search

• sign_up

• subscribe

• view_cart

• view_item

Required event fields

Many of the events have required fields if that type of event is sent. For example:

1. items must be provided for add_to_cart, begin_checkout, and remove_from_cart.

2. value must be provided for purchase.

3. searchTerm must be provided for search

User Data Properties

When you send events to AppLovin they will attempt to match those actions to a particular user in AppLovin.

Note: although listed as Recommended, at least one of the following user properties is required by AppLovin: client_id, axwrt, and alart.

Freshpaint property	AppLovin parameter	Type	Requirement	Description
$device_id	client_id	string	Recommended*	A stable first-party identifier that should be unique to the user. Freshpaint provides this value with from a cookie set by the Freshpaint SDK.
axwrt	axwrt	string	Optional	A custom value typically set by the Axon native Pixel. This is not needed with Freshpaint as long as the $device_id is used, which is provided by default with the Freshpaint SDK.
alart	alart	string	Optional	A custom value typically set by the Axon native Pixel. This is not needed with Freshpaint as long as the $device_id is used, which is provided by default with the Freshpaint SDK.
$user_agent	client_user_agent	string	Optional	The user agent of the browser.
$session_id	session_id	string	Optional	The ID of the user session.
esi	esi	string	Optional	Source of event. app or web. Freshpaint will default this to web.
ifa	ifa	string	Optional	The user’s identifier for advertisers. idfa or gaid
idfv	idfv	string	Optional	The user’s identifier for vendors
os	os	string	Optional	The user’s operating system: ios, android, or desktop_os.