adjust-icon

Configure session parameters

If you register a callback URL in the Adjust dashboard, Adjust sends a GET request to your callback URL when the SDK measures a session.

Session callback parameters

You can configure callback parameters to your servers. Once you configure parameters on an event, the SDK appends them to your callback URL. You can use this information to analyze your users’ in-app behavior with your BI system.

Add session callback parameters

Method signature
addSessionCallbackParameter: (key: string, value: string) => void

Add callback parameters to your event by calling the addSessionCallbackParameter method with string key-value arguments. You can add multiple parameters by calling this method multiple times.

Adjust.addSessionCallbackParameter("key", "value");

Remove session callback parameters

Method signature
removeSessionCallbackParameter: (key: string) => void

You can remove specific session callback parameters if they’re no longer required. To do this, pass the parameter key to the removeSessionCallbackParameter method.

Adjust.removeSessionCallbackParameter("key");

Reset session callback parameters

Method signature
resetSessionCallbackParameters: () => void

You can remove all session parameters if they’re no longer required. To do this, call the resetSessionCallbackParameters method.

Adjust.resetSessionCallbackParameters();

Session partner parameters

You can send extra information to your network partners by adding partner parameters.

Adjust sends partner parameters to external partners you’ve set up. This information is useful for more granular analysis and retargeting purposes. Adjust’s servers forward these parameters once you’ve set them up and enabled them for a partner.

Add session partner parameters

Method signature
addSessionPartnerParameter: (key: string, value: string) => void

Send partner parameters with your session by calling the addSessionPartnerParameter method with string key-value arguments. You can add multiple parameters by calling this method multiple times.

Adjust.addSessionPartnerParameter("key", "value");

Remove session partner parameters

Method signature
removeSessionPartnerParameter: (key: string) => void

You can remove specific session partner parameters if they’re no longer required. To do this, pass the parameter key to the removeSessionPartnerParameter method.

Adjust.removeSessionPartnerParameter("key");

Reset session partner parameters

Method signature
resetSessionPartnerParameters: () => void

You can remove all session partner parameters if they’re no longer required. To do this, call the resetSessionPartnerParameters method.

Adjust.resetSessionPartnerParameters();

Delay start

The Adjust SDK starts as soon as your app opens. If you want to send data that’s not available at launch in session parameters, you can delay the start of the SDK. To do this, pass the delay time in seconds to the setDelayStart method on your config object.

const adjustConfig = new AdjustConfig(
"{YourAppToken}",
AdjustConfig.EnvironmentSandbox,
);
//...
adjustConfig.setDelayStart(5.5);
//...
Adjust.create(adjustConfig);

After this time has elapsed, the SDK sends the information to Adjust’s servers. You can send the information before the timeout by calling the sendFirstPackages method.

Adjust.sendFirstPackages();