Blocklist API

Use the Adjust Blocklist API to block traffic from fraudulent or outdated links. You can blocklist custom links and partner links. You can’t blocklist Self-attributing network (SAN) partner links. To block traffic from a SAN partner link, you MUST delete the SAN partner. See Self-attributing network setup for a list of SAN partners.

Authentication

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

1. Select the account (user) icon.
2. Select Account settings.
3. Select the My profile tab.
4. 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:

1. Select the account (user) icon.
2. Select Account settings.
3. Select the My Profile tab.
4. Your API Token is shown with your User details.
5. Select Reset API token.
6. 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.
7. Select the copy button next to the API Token to copy the token to your system clipboard.

Blocklist a link

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

You can blocklist a link to stop recording engagements and callbacks to it. Blocklisted links retain their existing attributions until a user is reattributed to another link.

Clicks and impressions recorded before you blocklist a link stay eligible for attribution. For example, if you set a 7-day attribution window and blocklist a link on day 2, Adjust will still consider engagements from day 1 for attribution.

Parameters

The following parameter MUST be placed in the query path:

link (String)

An alphanumeric Adjust link token.

Response format

1
{
2
   "label": "string",
3
   "token": "string",
4
   "name": "string",
5
   "url": "string",
6
   "path": "string",
7
   "has_subtrackers": true,
8
   "archived": true,
9
   "visible": true,
10
   "attribution_partner": true,
11
   "creative_token": "string",
12
   "adgroup_token": "string",
13
   "campaign_token": "string",
14
   "network_token": "string",
15
   "click_url": "string",
16
   "impression_url": "string",
17
   "allow_partner_linking": true,
18
   "settings": {
19
      "partner_id": "string",
20
      "partner_display_name": "string",
21
      "tracking_parameters": "string",
22
      "cost_data_parameters": "string",
23
      "cost_data": true,
24
      "partner_cost_data_parameters": "string",
25
      "campaign_structure": "string",
26
      "additional_parameters": "string",
27
      "attribution_settings": "string",
28
      "blacklisted": true
29
   },
30
   "urls": {
31
      "descendants": "string",
32
      "ancestors": "string",
33
      "update": "string",
34
      "show": "string",
35
      "archive": "string",
36
      "unarchive": "string"
37
   }
38
}

Example

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

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

Unblocklist a link

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

You can unblocklist a link at any time to reactivate it. Once you unblocklist a link, Adjust immediately resumes measuring engagement and callbacks.

Only engagements received when a link is enabled are considered in your attribution funnel.

Parameters

The following parameter MUST be placed in the query path:

link (String)

An alphanumeric Adjust link token.

Response format

1
{
2
   "label": "string",
3
   "token": "string",
4
   "name": "string",
5
   "url": "string",
6
   "path": "string",
7
   "has_subtrackers": true,
8
   "archived": true,
9
   "visible": true,
10
   "attribution_partner": true,
11
   "creative_token": "string",
12
   "adgroup_token": "string",
13
   "campaign_token": "string",
14
   "network_token": "string",
15
   "click_url": "string",
16
   "impression_url": "string",
17
   "allow_partner_linking": true,
18
   "settings": {
19
      "partner_id": "string",
20
      "partner_display_name": "string",
21
      "tracking_parameters": "string",
22
      "cost_data_parameters": "string",
23
      "cost_data": true,
24
      "partner_cost_data_parameters": "string",
25
      "campaign_structure": "string",
26
      "additional_parameters": "string",
27
      "attribution_settings": "string",
28
      "blacklisted": true
29
   },
30
   "urls": {
31
      "descendants": "string",
32
      "ancestors": "string",
33
      "update": "string",
34
      "show": "string",
35
      "archive": "string",
36
      "unarchive": "string"
37
   }
38
}

Example

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

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

View link status

You can check which links are blocklisted in Campaign Lab. To do this:

1. Navigate to Campaign Lab.
2. Select a partner to display a list of associated links. Links on the blocklist display as Blocklisted.

You can hide blocklisted links in Campaign Lab. See hidden links in Campaign Lab for instructions.