Campaign API

Use the Campaign API to get link, sublink, and partner information. Create new links and update existing links with new partner information.

Authentication

The Campaign API uses Bearer tokens for authentication. You MUST include your Adjust API token in an Authorization header with each request you make to the Campaign 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.

Fetch partners

GET https://api.adjust.com/public/v1/partners

Use this endpoint to fetch a list of partners and associated data. Data are returned in an array of partner objects.

Parameters

You MAY pass the following parameters as query parameters:

after (String): The cursor position from which to start your request.
before (String): The cursor position at which to end your request.
limit (Integer): The maximum number of results to include in the response. This value MUST be a positive integer value. Defaults to 50.

Pagination

Results from this endpoint are paginated using a cursor. Each page returns the location of the previous and next pages. You can include these in your calls to return specific pages.

Each results page contains a paging object containing the cursor positions. You can use these cursor positions to programmatically move between pages. For example, the first page might contain the following paging object:

"paging": {
   "page_size": "50",
   "collection_size": "49",
   "total": "199",
   "cursors": {
      "after": "g2wAAAACYhW1_gxkAANuaWxq",
      "before": null
   },
   "next": "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
   "previous": null
}

To go to the second page, add the after value to the next request in the after parameter. For example:

$ curl "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq"

Response format

1
{
2
   "data": {
3
      "api_version": "string",
4
      "request_id": "string",
5
      "timestamp": "datetime",
6
      "paging": {
7
         "page_size": "string",
8
         "collection_size": "string",
9
         "total": "string",
10
         "next": "string",
11
         "previous": "string",
12
         "cursors": {
13
            "after": "string",
14
            "before": "string"
15
         }
16
      },
17
      "items": [
18
         {
19
            "id": 100,
20
            "display_name": "string",
21
            "supports_cost_data": true
22
         }
23
      ]
24
   }
25
}

Example

$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
-L -X GET 'https://api.adjust.com/public/v1/partners?limit=1'

{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "paging": {
         "page_size": "1",
         "collection_size": "1",
         "total": "199",
         "next": "https://api.adjust.com/public/v1/partners?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
         "previous": null,
         "cursors": {
            "after": "g2wAAAACYhW1_gxkAANuaWxq",
            "before": null
         }
      },
      "items": [
         {
            "id": 174,
            "display_name": "Adcolony",
            "supports_cost_data": true
         }
      ]
   }
}

Fetch links

GET https://api.adjust.com/public/v2/apps/{app_token}/trackers

GET https://api.adjust.com/public/v1/apps/{app_token}/trackers

Use this endpoint to fetch network-level links associated with your app.

Parameters

You MUST pass the following parameter in the path of your request:

app_token (String): The alphanumeric token that identifies your app. This MUST be 12 characters long.

You MAY pass the following parameters as query parameters:

cursor (String): A cursor position.
limit (Integer): The maximum number of results to include in the response. This value MUST be a positive integer value. Defaults to 50.

You MUST pass the following parameter in the path of your request:

app_token (String): The alphanumeric token that identifies your app. This MUST be 12 characters long.

You MAY pass the following parameters as query parameters:

after (String): The cursor position from which to start your request.
before (String): The cursor position at which to end your request.
limit (Integer): The maximum number of results to include in the response. This value MUST be a positive integer value. Defaults to 50.

Pagination

Results from this endpoint are paginated using a cursor. Each results page contains a paging object containing cursor positions. You can use these cursor positions to programmatically move between pages. For example, the first page might contain results like this:

"paging": {
   "next": "https://api.adjust.com/public/v2/apps/yxs12pfewq/trackers?cursor=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
   "cursor": "g2wAAAACYhW1_gxkAANuaWxq"
}

To go to the second page, follow the next link to return results from the next specified cursor position.

$ curl "https://api.adjust.com/public/v2/apps/yxs12pfewq/trackers?cursor=g2wAAAACYhW1_gxkAANuaWxq&limit=50"

To return to a specific location in the results, pass a cursor value in your requests query params.

Results from this endpoint are paginated using a cursor. Each page returns the location of the previous and next pages. You can include these in your calls to return specific pages.

"paging": {
   "page_size": "50",
   "collection_size": "49",
   "total": "199",
   "cursors": {
      "after": "g2wAAAACYhW1_gxkAANuaWxq",
      "before": null
   },
   "next": "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
   "previous": null
}

To go to the second page, follow the next link to return results from the next specified cursor position.

$ curl "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq"

Response format

All links are returned as items in the following format:

{
   "name": "String",
   "token": "String",
   "label": "String",
   "level": 1,
   "archived": false,
   "has_subtrackers": false,
   "partner_id": 3,
   "cost_data_enabled": false,
   "url": "String",
   "click_url": "String",
   "impression_url": "String"
}

Example

$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
-L -X GET 'https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers?limit=1'

{
   "data": {
      "paging": {
         "cursor": "g2wAAAACYhW1_gxkAANuaWxq",
         "next": "https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1"
      },
      "items": [
         {
            "archived": false,
            "has_subtrackers": false,
            "partner_id": 3,
            "cost_data_enabled": false,
            "label": "Adroll",
            "level": 1,
            "name": "Adroll",
            "token": "abc123",
            "url": "https://app.adjust.com/abc123",
            "click_url": "https://app.adjust.com/abc123?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/abc123?campaign={campaign_name}&idfa={idfa}&s2s=1"
         }
      ]
   }
}

$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
-L -X GET 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers?limit=1'

{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "paging": {
         "page_size": "1",
         "collection_size": "1",
         "total": "199",
         "next": "https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
         "previous": null,
         "cursors": {
            "after": "g2wAAAACYhW1_gxkAANuaWxq",
            "before": null
         }
      },
      "items": [
         {
            "archived": false,
            "has_subtrackers": false,
            "partner_id": 3,
            "cost_data_enabled": false,
            "label": "Adroll",
            "level": 1,
            "name": "Adroll",
            "token": "abc123",
            "url": "https://app.adjust.com/abc123",
            "click_url": "https://app.adjust.com/abc123?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/abc123?campaign={campaign_name}&idfa={idfa}&s2s=1"
         }
      ]
   }
}

Fetch sublinks

GET https://api.adjust.com/public/v2/apps/{app_token}/trackers/{link_token}/children

GET https://api.adjust.com/public/v1/apps/{app_token}/trackers/{link_token}/children

Use this endpoint to get the sublinks for your specified app.

Parameters

You MUST pass the following parameters in the path of your request:

app_token (String): The alphanumeric token that identifies your app. This MUST be 12 characters long.
tracker_token (String): The link token of the parent link the sublink is nested under.

You MAY pass the following parameters in your request’s query parameters

cursor (String): A cursor position.
limit (Integer): The maximum number of results to include in the response. This value MUST be a positive integer value. Defaults to 50.

You MUST pass the following parameters in the path of your request:

app_token (String): The alphanumeric token that identifies your app. This MUST be 12 characters long.
tracker_token (String): The link token of the parent link the sublink is nested under.

You MAY pass the following parameters in your request’s query parameters

after (String): The cursor position from which to start your request.
before (String): The cursor position at which to end your request.
limit (Integer): The maximum number of results to include in the response. This value MUST be a positive integer value. Defaults to 50.

Pagination

"paging": {
   "next": "https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers/abc123/children?cursor=g2wAAAACYhW1_gxkAANuaWxq",
   "cursor": "g2wAAAACYhW1_gxkAANuaWxq"
}

To go to the second page, follow the next link to return results from the next specified cursor position.

$ curl "https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers/abc123/children?cursor=g2wAAAACYhW1_gxkAANuaWxq"

To return to a specific location in the results, pass a cursor value in your requests query params.

Results from this endpoint are paginated using a cursor. Each page returns the location of the previous and next pages. You can include these in your calls to return specific pages.

"paging": {
   "page_size": "50",
   "collection_size": "49",
   "total": "199",
   "cursors": {
      "after": "g2wAAAACYhW1_gxkAANuaWxq",
      "before": null
   },
   "next": "https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/abc123/children?after=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
   "previous": null
}

To go to the second page, follow the next link to return results from the next specified cursor position.

$ curl "https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/abc123/children?after=g2wAAAACYhW1_gxkAANuaWxq"

Response format

1
{
2
   "name": "String",
3
   "token": "String",
4
   "label": "String",
5
   "level": 2,
6
   "archived": false,
7
   "has_subtrackers": false,
8
   "partner_id": null,
9
   "cost_data_enabled": false,
10
   "url": "String",
11
   "click_url": "String",
12
   "impression_url": "String"
13
}

Example

$ curl \
--header 'Authorization: Token token={API_TOKEN}'
-L -X GET 'https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers/abc123/children?limit=1' \

{
   "data": {
      "paging": {
         "next": "https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers/abc123/children?cursor=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
         "cursor": "g2wAAAACYhW1_gxkAANuaWxq"
      },
      "items": [
         {
            "name": "Adroll::SpringCampaign",
            "token": "xyz456",
            "label": "SpringCampaign",
            "level": 2,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": null,
            "cost_data_enabled": false,
            "url": "https://app.adjust.com/xyz456",
            "click_url": "https://app.adjust.com/xyz456?idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/xyz456?idfa={idfa}&s2s=1"
         }
      ]
   }
}

$ curl \
--header 'Authorization: Token token={API_TOKEN}'
-L -X GET 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/abc123/children?limit=1' \

{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "paging": {
         "page_size": "1",
         "collection_size": "1",
         "total": "199",
         "next": "https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/abc123/children?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
         "previous": null,
         "cursors": {
            "after": "g2wAAAACYhW1_gxkAANuaWxq",
            "before": null
         }
      },
      "items": [
         {
            "name": "Adroll::SpringCampaign",
            "token": "xyz456",
            "label": "SpringCampaign",
            "level": 2,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": null,
            "cost_data_enabled": false,
            "url": "https://app.adjust.com/xyz456",
            "click_url": "https://app.adjust.com/xyz456?idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/xyz456?idfa={idfa}&s2s=1"
         }
      ]
   }
}

Create links

POST https://api.adjust.com/public/v1/apps/{app_token}/trackers

Use this endpoint to create new links and sublinks for your app.

Parameters

You MUST pass the following parameter in the path of your request:

app_token (String): The alphanumeric token that identifies your app. This MUST be 12 characters long.

You MUST pass the following parameter in your request data:

name (String): The name of the new link.

You MAY pass the following parameter in your request data:

parent_token (String): The link token of the parent link the sublink is nested under. Only required if you’re creating a sublink.

Response format

1
{
2
   "name": "String",
3
   "token": "String",
4
   "label": "String",
5
   "level": 1,
6
   "archived": false,
7
   "has_subtrackers": false,
8
   "partner_id": 3,
9
   "cost_data_enabled": false,
10
   "url": "String",
11
   "click_url": "String",
12
   "impression_url": "String"
13
}

The following level values are available:

1: Network level
2: Campaign level
3: Adgroup level
4: Creative level

Example

The following examples demonstrate how to create a link and a sublink.

Create a link

$ curl --location --request POST 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers' \
--header 'Authorization: Token token={API_TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{"name": "Adroll"}'

{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "items": [
         {
            "name": "Adroll",
            "token": "abc123",
            "label": "Adroll",
            "level": 1,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": 3,
            "cost_data_enabled": false,
            "url": "https://app.adjust.com/abc123",
            "click_url": "https://app.adjust.com/abc123?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/abc123?campaign={campaign_name}&idfa={idfa}&s2s=1"
         }
      ]
   }
}

Create a sublink

$ curl --location --request POST 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers' \
--header 'Authorization: Token token={API_TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{"parent_token": "abc123", "name": "SpringCampaign"}'

{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "items": [
         {
            "name": "Adroll::SpringCampaign",
            "token": "xyz456",
            "label": "SpringCampaign",
            "level": 2,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": 3,
            "cost_data_enabled": false,
            "url": "https://app.adjust.com/xyz456",
            "click_url": "https://app.adjust.com/xyz456?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/xyz456?campaign={campaign_name}&idfa={idfa}&s2s=1"
         }
      ]
   }
}

Update links

PATCH https://api.adjust.com/public/v1/apps/{app_token}/trackers/{link_token}

Use this endpoint to update existing links and sublinks for your app. You can add new partners to links or control whether cost data is enabled.

Parameters

You MUST pass the following parameters in the path of your request:

app_token (String): The alphanumeric token that identifies your app. This MUST be 12 characters long.
tracker_token (String): The link token of the link you want to update.

You MAY pass the following parameters in the data of your request:

partner_id (Integer): The ID of the partner you want to attach to the link. See Fetch partners above to fetch a list of partners and their IDs.
cost_data_enabled (Boolean): Whether to enable Ad spend data for the link.

Response parameters

1
{
2
   "name": "String",
3
   "token": "String",
4
   "label": "String",
5
   "level": 1,
6
   "archived": false,
7
   "has_subtrackers": false,
8
   "partner_id": 3,
9
   "cost_data_enabled": false,
10
   "url": "String",
11
   "click_url": "String",
12
   "impression_url": "String"
13
}

The following level values are available:

1: Network level
2: Campaign level
3: Adgroup level
4: Creative level

Example

$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
--header 'Content-Type: application/json' \
--location --request PATCH 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/klm789' \
--data-raw '{"partner_id": 174, "cost_data_enabled": false}'

{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "items": [
         {
            "name": "Adcolony",
            "token": "klm789",
            "label": "Adcolony",
            "level": 1,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": 174,
            "cost_data_enabled": true,
            "url": "https://app.adjust.com/klm789",
            "impression_url": "https://s2s.adjust.com/impression/klm789?s2s=1&idfa=[IDFA]&gps_adid=[GOOGLE_AD_ID]&ip_address=  [IP_ADDRESS]&adcolony_click_id=[CLICK_ID]&android_id_upper_sha1=[SHA1_ANDROID_ID]&cost_id=[CLICK_ID]&cost_type=[BID_TYPE]&cost_amount=[BID]&cost_currency=USD",
            "click_url": "https://s2s.app.adjust.com/klm789?s2s=1&idfa=[IDFA]&gps_adid=[GOOGLE_AD_ID]&ip_address=[IP_ADDRESS]&adcolony_click_id=[CLICK_ID]&android_id_upper_sha1=[SHA1_ANDROID_ID]&cost_id=[CLICK_ID]&cost_type=[BID_TYPE]&cost_amount=[BID]&cost_currency=USD"
         }
      ]
   }
}