We constantly publish updates to our documentation, which may not yet be available in your language. For the most current information, use the English version.

for Developers

Server-to-server (S2S) sessions

Sessions are the base of all attribution and tracking in Adjust. They trigger when a user resumes using an app from the background or when they open the app. Use the S2S Session API to track each user session in your app.

Warning:

Adjust needs to turn this feature on for you. Contact your Technical Account Manager or support@adjust.com to proceed.

Before you begin

Authentication

Set up S2S Security to guarantee the security of your S2S sessions and protect against spoofed requests. This requires each incoming request to carry an authentication token generated in your Adjust dashboard. Requests that do not carry the token or that carry an incorrect token are rejected by our server.

Session tracking

Adjust groups sessions to save resources. This means there must be a gap of at least 30 minutes after a session, before the Adjust server accepts a new session as triggered.

Endpoint

https://s2s.adjust.com/session

POST header

Requirements:

Parameter Name	Description	Example
`Content-Type`	The format of the POST payload, hardcoded	application/x-www-form-urlencoded
`X-Adjust-Forwarded-For`	IP address of the device	180.220.253.39
`Authorization`	When you call Adjust APIs, send the value of your Adjust authentication token with the authentication type set as Bearer.	Bearer authentication_token

POST Payload

Parameters

The only required parameter in the payload is s2s. Find the full list of parameters in the table below.

Parameter	Description	Example
`s2s` REQUIRED	Server-to-server parameter: allows Adjust servers to recognize server-side activity. Must always be sent as 1.	1
`app_token`	Unique authentication token for your app	pezwd5bre2xb
`vida`	Vizio advertising identifier, Vizio only	dca2365e-0d78-47c6-aaac-9567846c6c9e
`rida`	Roku advertising identifier, Roku only
`tifa`	Tizen OS advertising identifier, Samsung only
`idfa`	iOS advertising identifier, iOS only	29DDE430-CE81-4F00-A50C-689595AAD142
`idfv`	iOS vendor identifier, iOS only	59E27F41-A86B-4560-B585-63161F871C4B
`gps_adid`	Google Play advertising identifier, only sent if Google Play Services library is added. Android only	6cf94580-46c2-490c-b882-2f6ae269b579
`oaid`	Open Advertising ( Anonymous ) identifier	ed799bac-2537-6122-377a-edebce5db5a5
`imei`	International Mobile Equipment Identity	490154203237518
`android_id`	Android identifier, only sent if gps_adid is not present. Android only	e11a8c233efb29f3
`persistent_ios_uuid`	Same as ios_uuid, but saved in Keychain so that re-installed apps will have same value, iOS only	3b35fcfb-6115-4cff-830f-e32a248c487d
`app_version`	This parameter represents build number in iOS and actual app version in Android.	1.0
`app_version_short`	The release represents actual app version number in iOS, iOS only	1.0
`session_count`	Number of tracked sessions including current one.	1
`subsession_count`	Number of sub-sessions tracked. First session ever tracked (Install) doesn't contain this parameter. Every subsequent session contains number of sub-sessions for previous session.	1
`session_length`	Length of session in seconds. First session ever tracked (Install) doesn't contain this parameter. Every subsequent session contains length of the previous session.	123
`time_spent`	Time spent active during previous session	123
`tracking_enabled`	Indicates whether the user has limited ad tracking enabled	1
`bundle_id`	The bundle identifier, iOS only.	com.adjust.example
`package_name`	The package name, Android only.	com.adjust.example
`environment`	“sandbox” for testing or “production” for live traffic	sandbox
`country`	Local country code	de
`language`	Local language code	en
`os_name`	“ios” or “android” just the string	ios
`os_version`	Current version of the operating system	11.0
`cpu_type`	Processor family of CPU	arm64-v8a
`created_at`	Timestamp of local device, creation of the package including timezone.	2018-03-23T09:46:47.288Z-0400
`sent_at`	Timestamp of local device, sending the package including timezone.	2018-03-23T09:47:47.288Z-0400"
`device_type`	Model of the device	Phone (android), iphone
`device_name`	Model identifier, make sure to encode	Moto G (5) Plus, iPhone10,5
`hardware_name`	Device board configuration	N66AP
`install_receipt`	Install receipt from App Store that is cryptographically signed, iOS only	Super long string representation of the receipt
`ip_address`	The IP address of the device. The `ip_address` parameter accepts only IPv4 addresses. IPv6 isn't currently supported.	`ip_address=192.0.0.1`

Request example

cURL

curl -X 'POST' -d 'app_token=a1234b2x3a4o&app_version=Roku%2FDVP-10.5+%2810.5.0.0010%29&created_at_unix=1543915806015&environment=production&os_name=android&rida=099aa0bc-d123-4567-8999-a1b7c50767b1&s2s=1' -H 'Authorization: Bearer ADD_YOUR_AUTH_TOKEN_HERE' -H 'User-Agent: Adjust Streaming Job (akka-http)' 'https://s2s.adjust.com/session'

Response:

JSON

{
    "Host": "s2s.adjust.com",
    "Path": "/session",
    "Method": "POST",
    "ReceivedAt": "2022-01-01T17:00:01.030986068Z",
    "Header": {
        "Connection": [
            "close"
        ],
        "User-Agent": [
            "Adjust Streaming Job (akka-http)"
        ],
        "Authorization": [
            "Bearer ADD_YOUR_AUTH_TOKEN_HERE"
        ],
        "Content-Length": [
            "0"
        ],
        "X-Adjust-Forwarded-For": [
            "71.142.112.183",
            "34.221.136.124"
        ],
        "X-Adjust-Forwarded-Proto": [
            "https"
        ]
    },
    "Form": {
        "s2s": [
            "1"
        ],
        "rida": [
            "099aa0bc-d123-4567-8999-a1b7c50767b1"
        ],
        "os_name": [
            "android"
        ],
        "app_token": [
            "a1234b2x3a4o"
        ],
        "app_version": [
            "Roku/DVP-10.5 (10.5.0.0010)"
        ],
        "environment": [
            "production"
        ],
        "created_at_unix": [
            "1543915806015"
        ]
    }
}