Use Adjust APIs to conveniently access your data. Our APIs are the quick and efficient way to utilize Adjust’s Dashboard data for your business needs.

All Adjust APIs are available to clients in or above a Business Pro package.

1REST API authentication

To make a REST API call, you must use request headers. This includes the authorization header with your Adjust API token.

Request header Description
Authorization
Required
When you call Adjust APIs, send the value of your Adjust API token with the authentication type set as Bearer. Example: Authorization: Bearer API_Token

2How to find your Adjust API token

You can locate your Adjust API token in your Adjust Dashboard.

Instructions

  1. Account Settings > Users
  2. Identify your username and select the gray caret at the bottom of the window
  3. Select User details
  4. Locate your API token in the last field of the sidebar

Adjust API tokens are assigned per user and can be used with any of your Adjust integrated apps, for any Adjust Dashboard account. Your Adjust API token is unique to your Adjust username and should never be disclosed to other users.

3Device API

Use the device API to view device information and clear device history from Adjust for testing purposes.

3.1Inspect device

Use the Adjust device endpoint to inspect device activity.

Endpoint:

https://api.adjust.com/device_service/api/v1/inspect_device

Current version: v1

Requirements:

Request header Definition
app_token
Required
The 10 character alphanumeric string identifier assigned to your app within Adjust
advertising_id
Required
The unique advertising identification number assigned to your device. Adjust supports the following identification types: IDFA (iOS); Google Advertising ID (Android); Android ID (Android); Windows Advertising ID (Windows); Fire Advertising ID (Kindle)

Sample request example (using curl):

curl -H "Authorization: Bearer ask43jskdp2tg2hg87" "https://api.adjust.com/device_service/api/v1/inspect_device?advertising_id=1234-5678-9012-3456&app_token=tei4k374ke"

Sample Response:

{
    "Adid": "acf8534f2f052395e617a38730682ccc",
    "AdvertisingId": "1234-5678-9012-3456",
    "Tracker": "abc123",
    "TrackerName": "Organic",
    "ClickTime": "0001-01-01T00:00:00Z",
    "InstallTime": "2015-08-19T03:42:03Z",
    "LastSessionTime": "2017-07-29T17:29:17Z",
    "LastEventTimes": {
        "a1a1a1": "2017-07-29T17:29:55Z",
        "b2b2b2": "2017-07-29T17:29:21Z",
        "c3c3c3": "2017-07-29T17:29:38Z",
        "4d4d4d": "2017-07-29T17:29:58Z"},
    "State": "installed"
}

Response definitions:

Property Type Description
Adid string An Adid is an internal identification number assigned to every Adjust tracked device.
AdvertisingID string The unique device identifier used in original query.
Tracker string The tracker token for the device’s current attribution source.
TrackerName string The tracker name for the device’s current attribution source.
ClickTime string The click timestamp on record for any device. Any device currently attributed as Organic will have a click timestamp of "0001-01-01T00:00:00Z"
InstallTime string The install timestamp on record for any device.
LastSessionTime string The timestamp for the the latest session on record.
LastEventTimes string The timestamp(s) for the latest event trigger(s), if any.
State string The device’s current attribution state. Possible values: installed; reattributed

3.2Forget device

Use the Adjust forget device endpoint to clear device history from Adjust and test multiple installs on the same device.

Endpoint:

https://api.adjust.com/device_service/api/v1/forget_device

Current version: v1

Requirements:

Request header Definition
app_token
Required
The 10 character alphanumeric identifier assigned to your app within Adjust
adid
Required
The internal identification number assigned to every Adjust tracked device

Sample request example (using curl):

curl -d "adid=acf8534f2f052395e617a38730682ccc&app_token=tei4k374ke" -X POST -H "Authorization: Token token=ask43jskdp2tg2hg87" "https://api.adjust.com/device_service/api/v1/forget_device"

Sample response:

Forgot device

4Blacklist tracker API

The Adjust blacklist tracker API is used to block traffic from fraudulent or outdated trackers URLs. When a tracker is blacklisted, Adjust no longer attributes engagements (i.e., clicks and impressions) to that tracker. Blacklisted trackers retain their existing attributions; this means that a user’s in-app sessions and events will remain affiliated with the blacklisted tracker URL until they are reattributed to one of your other, active trackers. It is also important to note that any clicks or impressions recorded before the tracker was blacklisted are still eligible for conversion within the attribution window.

For example, if there is a seven-day attribution window and the tracker is blacklisted on day 2, it is still possible to attribute installs later in the week to clicks recorded on day 1.

If you select the settings (gear) icon beside a blacklisted tracker in the Campaign Wizard, the tracker will display as BLACKLISTED. If you select EDIT for a blacklisted tracker, the only available option is to archive the tracker. When you archive a tracker, you hide it from your list of active tracker URLs. You can archive or unarchive a blacklisted tracker at any time.

It is also possible to unblacklist trackers using the Adjust blacklist tracker API. Once a tracker is unblacklisted, Adjust will resume tracking engagements from the tracker and you will be able to edit the tracker settings in the Adjust Campaign Wizard. While unblacklisting a tracker takes immediate effect, it does not retroactively apply to your attribution data. Only the tracker engagements made after the time of unblacklisting will be considered within your attribution funnel.

4.1Blacklist tracker

Use the blacklist tracker endpoint to block engagement measurement and attribution to a tracker and any related subtrackers.

Endpoint:

https://api.adjust.com/dashboard/api/trackers/{tracker}/blacklist

Requirements:

Parameter Definition
{tracker}
Required
Alphanumeric Adjust tracker token

Sample request example (using curl):

curl -H "Authorization: Token token={api_token}" -X POST "https://api.adjust.com/dashboard/api/trackers/abc123/blacklist"

Sample response:

{
  "label": "Twitter installs",
  "token": "abc123",
  "name": "Twitter installs",
  "url": "https://app.adjust.com/abc123",
  "path": "",
  "has_subtrackers": true,
  "archived": false,
  "visible": true,
  "attribution_partner": false,
  "creative_token": null,
  "adgroup_token": null,
  "campaign_token": null,
  "network_token": "abc123",
  "click_url": "https://app.adjust.com/abc123",
  "impression_url": "https://view.adjust.com/impression/abc123",
  "allow_partner_linking": true,
  "settings": {
    "partner_id": null,
    "partner_display_name": null,
    "tracking_parameters": null,
    "cost_data_parameters": null,
    "cost_data": false,
    "partner_cost_data_parameters": null,
    "campaign_structure": null,
    "additional_parameters": null,
    "attribution_settings": null,
    "blacklisted": true
  },
  "urls": {
    "descendants": "/api/trackers/abc123/descendants.json",
    "ancestors": "/api/trackers/abc123/ancestors.json",
    "update": "/api/trackers/abc123.json",
    "show": "/api/trackers/abc123.json",
    "archive": "/api/trackers/abc123/archive.json",
    "unarchive": "/api/trackers/abc123/unarchive.json"
  }
}

4.2Unblacklist tracker

Use the unblacklist tracker endpoint to renew engagement measurement and attribution to a tracker and any related subtrackers.

Endpoint:

https://api.adjust.com/dashboard/api/trackers/{tracker}/unblacklist

Requirements:

Parameter Definition
{tracker}
Required
Alphanumeric Adjust tracker token (at least 6 characters long)

Sample request example (using curl):

curl -H "Authorization: Token token={api_token}" -X POST "https://api.adjust.com/dashboard/api/trackers/abc123/unblacklist"

Sample response:

{
  "label": "Twitter installs",
  "token": "abc123",
  "name": "Twitter installs",
  "url": "https://app.adjust.com/abc123",
  "path": "",
  "has_subtrackers": true,
  "archived": false,
  "visible": true,
  "attribution_partner": false,
  "creative_token": null,
  "adgroup_token": null,
  "campaign_token": null,
  "network_token": "abc123",
  "click_url": "https://app.adjust.com/abc123",
  "impression_url": "https://view.adjust.com/impression/abc123",
  "allow_partner_linking": true,
  "settings": {
    "partner_id": null,
    "partner_display_name": null,
    "tracking_parameters": null,
    "cost_data_parameters": null,
    "cost_data": false,
    "partner_cost_data_parameters": null,
    "campaign_structure": null,
    "additional_parameters": null,
    "attribution_settings": null,
    "blacklisted": false
  },
  "urls": {
    "descendants": "/api/trackers/abc123/descendants.json",
    "ancestors": "/api/trackers/abc123/ancestors.json",
    "update": "/api/trackers/abc123.json",
    "show": "/api/trackers/abc123.json",
    "archive": "/api/trackers/abc123/archive.json",
    "unarchive": "/api/trackers/abc123/unarchive.json"
  }
}