Skip to content

Commit

Permalink
Move all files
Browse files Browse the repository at this point in the history
Replace imports with inline text
  • Loading branch information
Sporiff committed Feb 19, 2024
1 parent c0c383f commit 4226471
Show file tree
Hide file tree
Showing 358 changed files with 552 additions and 304 deletions.
File renamed without changes.
38 changes: 38 additions & 0 deletions src/content/docs/api/app-automation-api/authentication.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "App automation API Authentication"
description: "You need a bearer token to use the App automation API."
slug: en/api/app-automation-api/authentication
sidebar-position: 1
sidebar-label: Authentication
---

You need a [bearer token](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) to use the App automation API. You can get this token in the Adjust dashboard by following the steps in this article.

## Find your Adjust API token

Before you can start making API calls, you first need to find your Adjust API token. You can find your Adjust API token in your Adjust dashboard.

<Callout type="important">

If you've configured SSO, your API tokens aren't available in the Adjust dashboard. Reach out to your Adjust representative or [email protected] for help with API tokens.

</Callout>

Your Adjust API token is located in your **profile**. To find it, follow these steps:

1. Select the settings icon (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User Details</GuiLabel>. Select the copy button (<Icon name="Copy" />) 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. This means that any requests made using the old token won't work. If you reset your Adjust API token, you need to make sure to update it wherever it's in use.

1. Select the settings icon (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My Profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User details</GuiLabel>.
5. Select <GuiLabel>Reset API token</GuiLabel>. A popup modal appears.
6. Enter your account password in the modal and select <GuiLabel>Reset</GuiLabel> to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
7. Select the copy button (<Icon name="Copy" />) next to the <GuiLabel>API Token</GuiLabel> to copy the token to your system clipboard.
38 changes: 38 additions & 0 deletions src/content/docs/api/blocklist-api/authentication.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "Blocklist API Authentication"
description: "You need a bearer token to use the Blocklist API."
slug: en/api/blocklist-api/authentication
sidebar-position: 1
sidebar-label: Authentication
---

You need a [bearer token](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) to use the Blocklist API. You can get this token in the Adjust dashboard by following the steps in this article.

## Find your Adjust API token

Before you can start making API calls, you first need to find your Adjust API token. You can find your Adjust API token in your Adjust dashboard.

<Callout type="important">

If you've configured SSO, your API tokens aren't available in the Adjust dashboard. Reach out to your Adjust representative or [email protected] for help with API tokens.

</Callout>

Your Adjust API token is located in your **profile**. To find it, follow these steps:

1. Select the settings icon (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User Details</GuiLabel>. Select the copy button (<Icon name="Copy" />) 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. This means that any requests made using the old token won't work. If you reset your Adjust API token, you need to make sure to update it wherever it's in use.

1. Select the settings icon (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My Profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User details</GuiLabel>.
5. Select <GuiLabel>Reset API token</GuiLabel>. A popup modal appears.
6. Enter your account password in the modal and select <GuiLabel>Reset</GuiLabel> to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
7. Select the copy button (<Icon name="Copy" />) next to the <GuiLabel>API Token</GuiLabel> to copy the token to your system clipboard.
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ slug: en/api/blocklist-api/blocklist
sidebar-position: 2
---

import BlocklistCallout from "@content/en/api/partials/_Blocklist.mdx";
<Callout type="important">

<BlocklistCallout />
"Blacklist" and "whitelist" have been renamed to "blocklist" and "allowlist" respectively. Currently this change applies to the UI and documentation. While Adjust works towards updating the codebase, you'll still see the term "blacklist" in the API endpoints.

</Callout>

Blocklist a link to block engagement measurement, attribution and callbacks to it and any related subtrackers.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ category-title: Blocklist API
slug: en/api/blocklist-api
---

import BlocklistCallout from "@content/en/api/partials/_Blocklist.mdx"
<Callout type="important">

"Blacklist" and "whitelist" have been renamed to "blocklist" and "allowlist" respectively. Currently this change applies to the UI and documentation. While Adjust works towards updating the codebase, you'll still see the term "blacklist" in the API endpoints.

<BlocklistCallout />
</Callout>

Use the Adjust Blocklist API to block traffic from fraudulent or outdated tracker URLs. Blocklisted trackers display a <GuiLabel>BLOCKLISTED</GuiLabel> label in the dashboard.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ slug: en/api/blocklist-api/unblocklist
sidebar-position: 3
---

import BlocklistCallout from "@content/en/api/partials/_Blocklist.mdx";
<Callout type="important">

<BlocklistCallout />
"Blacklist" and "whitelist" have been renamed to "blocklist" and "allowlist" respectively. Currently this change applies to the UI and documentation. While Adjust works towards updating the codebase, you'll still see the term "blacklist" in the API endpoints.

</Callout>

Unblocklist a link to re-enable engagement measurement, attribution and callbacks to it and any related subtrackers.

Expand Down
38 changes: 38 additions & 0 deletions src/content/docs/api/campaign-api/authentication.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "Campaign API Authentication"
description: "You need a bearer token to use the Campaign API."
slug: en/api/campaign-api/authentication
sidebar-position: 1
sidebar-label: Authentication
---

You need a [bearer token](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) to use the Campaign API. You can get this token in the Adjust dashboard by following the steps in this article.

## Find your Adjust API token

Before you can start making API calls, you first need to find your Adjust API token. You can find your Adjust API token in your Adjust dashboard.

<Callout type="important">

If you've configured SSO, your API tokens aren't available in the Adjust dashboard. Reach out to your Adjust representative or [email protected] for help with API tokens.

</Callout>

Your Adjust API token is located in your **profile**. To find it, follow these steps:

1. Select the settings icon (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User Details</GuiLabel>. Select the copy button (<Icon name="Copy" />) 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. This means that any requests made using the old token won't work. If you reset your Adjust API token, you need to make sure to update it wherever it's in use.

1. Select the settings icon (<Icon name="CogWheel" />) in the bottom left corner.
2. Select <GuiLabel>Account settings</GuiLabel>. Your account settings page opens.
3. Select the <GuiLabel>My Profile</GuiLabel> tab.
4. Your <GuiLabel>API Token</GuiLabel> is shown with your <GuiLabel>User details</GuiLabel>.
5. Select <GuiLabel>Reset API token</GuiLabel>. A popup modal appears.
6. Enter your account password in the modal and select <GuiLabel>Reset</GuiLabel> to reset your API token. The modal closes and a confirmation appears in the top right of the screen.
7. Select the copy button (<Icon name="Copy" />) next to the <GuiLabel>API Token</GuiLabel> to copy the token to your system clipboard.
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ slug: en/api/campaign-api/create-tracker
sidebar-position: 4
---

import TrackerLevels from "@content/en/api/partials/_Tracker-levels.mdx";

Use this endpoint to create new trackers and subtrackers for your app.

```http title="Endpoint" "{app_token}/trackers"
Expand Down Expand Up @@ -48,7 +46,14 @@ Create a new tracker or subtracker associated to your app.

</Table>

<TrackerLevels />
<Accordion title="Tracker levels">

- Network = `1`
- Campaign = `2`
- Adgroup = `3`
- Creative = `4`

</Accordion>

```json title="Response format"
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ slug: en/api/campaign-api/get-partners
sidebar-position: 6
---

import Pagination from "@content/en/api/partials/_Pagination.mdx";

Use this endpoint to fetch a list of partners and associated data.

```http title="Endpoint" "/partners"
Expand All @@ -29,7 +27,31 @@ Fetch a list of partners and associated data. Data are returned in an array of p

</Table>

<Pagination />
### 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. You can also limit the number of items included on a page. The default limit is `50`.

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

```json title="Pagination example"
"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:

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

### Response parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ slug: en/api/campaign-api/get-subtrackers
sidebar-position: 3
---

import Pagination from "@content/en/api/partials/_Pagination.mdx";
import TrackerLevels from "@content/en/api/partials/_Tracker-levels.mdx";

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

```http title="Endpoint" "/{app_token}/trackers/{tracker_token}/children"
Expand All @@ -30,7 +27,31 @@ Return a list of subtrackers associated with your app.

</Table>

<Pagination />
### 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. You can also limit the number of items included on a page. The default limit is `50`.

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

```json title="Pagination example"
"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:

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

### Response parameters

Expand All @@ -52,7 +73,14 @@ Return a list of subtrackers associated with your app.

</Table>

<TrackerLevels />
<Accordion title="Tracker levels">

- Network = `1`
- Campaign = `2`
- Adgroup = `3`
- Creative = `4`

</Accordion>

```json title="Response format"
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ sidebar-position: 2
sidebar-label: Get trackers
---

import Pagination from "@content/en/api/partials/_Pagination.mdx";
import TrackerLevels from "@content/en/api/partials/_Tracker-levels.mdx";

Use this endpoint to get the network-level trackers for your specified app.

```http title="Endpoint" "/{app_token}/trackers"
Expand All @@ -30,7 +27,31 @@ Return a list of network-level trackers associated with your app.

</Table>

<Pagination />
### 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. You can also limit the number of items included on a page. The default limit is `50`.

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

```json title="Pagination example"
"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:

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

### Response parameters

Expand All @@ -51,7 +72,14 @@ Return a list of network-level trackers associated with your app.

</Table>

<TrackerLevels />
<Accordion title="Tracker levels">

- Network = `1`
- Campaign = `2`
- Adgroup = `3`
- Creative = `4`

</Accordion>

```json title="Success response"
{
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ slug: en/api/campaign-api/update-tracker
sidebar-position: 5
---

import TrackerLevels from "@content/en/api/partials/_Tracker-levels.mdx";

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

```http title="Endpoint" "{app_token}/trackers/{tracker_token}"
Expand Down Expand Up @@ -49,7 +47,14 @@ Update a tracker or subtracker associated to your app.

</Table>

<TrackerLevels />
<Accordion title="Tracker levels">

- Network = `1`
- Campaign = `2`
- Adgroup = `3`
- Creative = `4`

</Accordion>

```json title="Response format"
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
---
title: "Device API Authentication"
description: "You need a bearer token to use the Device API."
slug: en/api/device-api/authentication
sidebar-position: 1
sidebar-label: Authentication
---

You need a [bearer token](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) to use the Device API. You can get this token in the Adjust dashboard by following the steps in this article.

## Find your Adjust API token

Before you can start making API calls, you first need to find your Adjust API token. You can find your Adjust API token in your Adjust dashboard.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 4226471

Please sign in to comment.