Adjust S2S API Reference

Destination Info

Client-side
Server-side

Web

Mobile

Server

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

Events

Event Properties

All events sent to Adjust include the following common parameters.

Common Parameters

Freshpaint Property
Adjust Parameter
Notes

$os

os_name

Mapped to Adjust OS strings: ios, android, macos, windows, linux. Defaults to server if missing or unrecognized.

time

created_at_unix

Unix timestamp of the event. Defaults to current server time if not present.

$ip

ip_address

Recommended. IPv4 only. IPv6 addresses are ignored.

$user_agent

user_agent

Recommended.

$device_model or $device

device_name

$device_model takes precedence.

$device_version or os_version

os_version

$device_version takes precedence.

device_type

device_type

$app_version

app_version

Recommended. On iOS, also sent as app_version_short.

(config)

app_token

Your Adjust App Token, set in destination configuration.

(config)

environment

sandbox or production, set in destination configuration.

(constant)

s2s

Always 1.

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

Device Identifier Properties

Freshpaint requires at least one device identifier to forward an event to Adjust. If none of the following are present, the event will be dropped.

Freshpaint Property
Adjust Parameter
Platform

$idfa

idfa

iOS

$idfv

idfv

iOS

$gaid

gps_adid

Android

$android_id

android_id

Android

adjust_device_id

adid

Any

Session-Specific Properties

The following parameters are only included when the event is routed to the /session endpoint.

Freshpaint Property
Adjust Parameter
Notes

$att_status

att_status

Recommended. Apple ATT consent status. Mapped to numeric values: notDetermined0, restricted1, denied2, authorized3. If $idfa is present and $att_status is not set, defaults to 3 (authorized).

primary_dedupe_token (custom) or persistent device ID

primary_dedupe_token

Used for session deduplication. Falls back to Freshpaint's persistent device ID if the custom property is not set.


Event-Specific Properties

The following parameters are only included when the event is routed to the /event endpoint.

Freshpaint Property
Adjust Parameter
Notes

(config)

event_token

Required. The Adjust event token corresponding to the Freshpaint event name. See Event Token Mapping below.

revenue

revenue

currency

currency

Adjust only accepts event tokens for events that have been configured in their events page of the application. Please copy them over to your Freshpaint Adjust S2S configuration page. See Adjust S2S API Quick Start Guidefor more information.

Last updated

Was this helpful?