Device API

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

Requirements

Forgetting a device is a destructive action. Your account MUST have one of the following user permissions to use the forget device endpoint.

Admin.
Editor.
Custom editor with access to the target app.

Authentication

The Device API uses Bearer tokens for authentication. You MUST include your Adjust API token in an Authorization header with each request you make to the Device API.

If your organization has enabled Single Sign-On (SSO), contact your Adjust representative or email support@adjust.com for help with finding your API token.

For non-SSO accounts, API tokens are located in a user’s profile. To find your token, follow these steps:

Select the account (user) icon.
Select Account settings.
Select the My profile tab.
Your API Token is shown with your User Details. Select the copy button to copy the token to your system clipboard.

Reset your Adjust API token

You can reset your Adjust API token at any time. Resetting your token invalidates the old token. If you reset your Adjust API token, you MUST replace your old token anywhere that you’re using it. Requests made with an invalidated token are rejected by Adjust.

To reset your Adjust API token:

Select the account (user) icon.
Select Account settings.
Select the My Profile tab.
Your API Token is shown with your User details.
Select Reset API token.
Enter your account password in the modal that appears and select Reset to reset your API token. A confirmation appears in the top right of the screen.
Select the copy button next to the API Token to copy the token to your system clipboard.

Inspect a device

GET https://api.adjust.com/device_service/api/v2/inspect_device

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

Use the Inspect device endpoint to fetch device and link information relating to an app.

Parameters

The following parameters MUST be added as query parameters.

app_token (String): The alphanumeric token that identifies your app. This MUST be 12 characters long.
advertising_id (String): The unique advertising ID associated with your device.

The following advertising IDs are available:

idfa: The ID For Advertisers. Only available on iOS devices.
gps_adid: The Google advertising ID. Only available on Android devices using the Google Play Store.
android_id: The Android device ID. Only available on Android devices.
fire_adid: The Amazon Fire advertising ID. Only available on Android devices using the Amazon Fire store.
win_adid: The Windows advertising ID. Only available on Windows devices.

Response format

1
{
2
   "Adid": "string",
3
   "AdvertisingId": "string",
4
   "Tracker": "string",
5
   "TrackerName": "string",
6
   "Environment": "string",
7
   "ClickTime": "date-time",
8
   "InstallTime": "date-time",
9
   "LastSessionTime": "date-time",
10
   "LastEventsInfo": {
11
      "{event_id}": {
12
         "name": "string",
13
         "time": "date-time"
14
      },
15
      "{event_id}": {
16
         "name": "string",
17
         "time": "date-time"
18
      },
19
      "{event_id}": {
20
         "name": "string",
21
         "time": "date-time"
22
      }
23
   },
24
   "LastSdkVersion": "ios4.37.2",
25
   "State": "string"
26
}

1
{
2
   "Adid": "string",
3
   "AdvertisingId": "string",
4
   "Tracker": "string",
5
   "TrackerName": "string",
6
   "ClickTime": "date-time",
7
   "InstallTime": "date-time",
8
   "LastSessionTime": "date-time",
9
   "LastEventTimes": {
10
      "string": "date-time",
11
      "string": "date-time",
12
      "string": "date-time",
13
      "string": "date-time"
14
   },
15
   "State": "string"
16
}

Example

$ curl \
--header "Authorization: Bearer ask43jskdp2tg2hg87" \
-L -X GET "https://api.adjust.com/device_service/api/v2/inspect_device?advertising_id=1234-5678-9012-3456&app_token=gwzpeepw8uf8"

{
   "Adid": "acf8534f2f052395e617a38730682ccc",
   "AdvertisingId": "1234-5678-9012-3456",
   "Tracker": "abc123",
   "TrackerName": "Organic",
   "FirstTracker": "zr5vueb",
   "FirstTrackerName": "Organic",
   "Environment": "sandbox",
   "ClickTime": "0001-01-01T00:00:00Z",
   "InstallTime": "2015-08-19T03:42:03Z",
   "LastSessionTime": "2017-07-29T17:29:17Z",
   "LastEventsInfo": {
      "kgfcul": {
         "name": "Copy IDFA",
         "time": "2024-07-18T10:01:16Z"
      },
      "wz9qqz": {
         "name": "Accept Terms",
         "time": "2024-07-01T14:13:47Z"
      },
      "z3f773": {
         "name": "Copy IDFV",
         "time": "2024-07-01T19:01:39Z"
      }
   },
   "LastSdkVersion": "ios4.37.2",
   "State": "installed"
}

$ curl \
--header "Authorization: Bearer ask43jskdp2tg2hg87" \
-L -X GET "https://api.adjust.com/device_service/api/v1/inspect_device?advertising_id=1234-5678-9012-3456&app_token=gwzpeepw8uf8"

{
   "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"
}

Forget a device

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

Use the forget device endpoint to clear a device’s information from Adjust’s servers. You can use this to test installs on a device multiple times.

Parameters

The following parameters MUST be added as request data.

app_token (String): The alphanumeric token that identifies your app. This MUST be 12 characters long.
adid (String): The device’s unique Adjust Identifier. Use the Inspect device endpoint to find your device’s ADID.

Example

$ curl \
--header "Authorization: Token token=ask43jskdp2tg2hg87" \
--location --request POST "https://api.adjust.com/device_service/api/v1/forget_device" \
--data "adid=acf8534f2f052395e617a38730682ccc&app_token=gwzpeepw8uf8"

200: Forgot device