From 670d2251dcd8fd67553238099939360818756185 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Tue, 1 Aug 2023 14:56:07 +0200 Subject: [PATCH 1/9] feat: Initial MDX import --- .../docs/en/api/device-api/authentication.mdx | 11 +++ src/content/docs/en/api/device-api/forget.mdx | 57 +++++++++++++ src/content/docs/en/api/device-api/index.mdx | 22 +++++ .../docs/en/api/device-api/inspect.mdx | 81 +++++++++++++++++++ src/content/docs/en/api/index.mdx | 6 ++ 5 files changed, 177 insertions(+) create mode 100644 src/content/docs/en/api/device-api/authentication.mdx create mode 100644 src/content/docs/en/api/device-api/forget.mdx create mode 100644 src/content/docs/en/api/device-api/index.mdx create mode 100644 src/content/docs/en/api/device-api/inspect.mdx create mode 100644 src/content/docs/en/api/index.mdx diff --git a/src/content/docs/en/api/device-api/authentication.mdx b/src/content/docs/en/api/device-api/authentication.mdx new file mode 100644 index 000000000..1bf67de37 --- /dev/null +++ b/src/content/docs/en/api/device-api/authentication.mdx @@ -0,0 +1,11 @@ +--- +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. + +## Before you begin diff --git a/src/content/docs/en/api/device-api/forget.mdx b/src/content/docs/en/api/device-api/forget.mdx new file mode 100644 index 000000000..36b67e57e --- /dev/null +++ b/src/content/docs/en/api/device-api/forget.mdx @@ -0,0 +1,57 @@ +--- +title: "Forget device endpoint" +description: "Use the Adjust forget device endpoint to clear device history from Adjust and test multiple installs on the same device." +slug: en/api/device-api/forget +sidebar-position: 3 +--- + +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 +``` + +### POST request + +Clears the device's information from Adjust. + +- - Parameter + - Data type + - In + - Description +- - `app_token`\* + - String + - Data + - Your app's 12 digit identifier +- - `adid`\* + - String + - Data + - The device's Adjust ID + +- - Response + - Message + - Description +- - 200 + - Forgot device + - Success response + +## Example + +```console +$ curl --location --request POST "https://api.adjust.com/device_service/api/v1/forget_device" \ +--header "Authorization: Token token=ask43jskdp2tg2hg87" \ +--data "adid=acf8534f2f052395e617a38730682ccc&app_token=gwzpeepw8uf8" +``` + +```console +Forgot device +``` diff --git a/src/content/docs/en/api/device-api/index.mdx b/src/content/docs/en/api/device-api/index.mdx new file mode 100644 index 000000000..4a545eff2 --- /dev/null +++ b/src/content/docs/en/api/device-api/index.mdx @@ -0,0 +1,22 @@ +--- +title: "Device API" +description: "Use the device API to view device information and clear device history from Adjust for testing purposes." +category-title: Device API +slug: en/api/device-api/index +--- + +Use the device API to view device information and clear device history from Adjust for testing purposes. + +## How it works + +1. Authenticate your calls + + To use the Device API endpoints, you first need to get your Adjust API token. Follow the instructions in the [Authentication article](authentication.mdx) to find out how to use this token with the API. + +2. Inspect device details + + Use the [inspect device endpoint](inspect.mdx) to return details about a device and associated user activity. + +3. Forget a device + + Use the [forget device endpoint](forget.mdx) to clear device history from Adjust. This is useful if you need to clear device data to test multiple installs on the same device. diff --git a/src/content/docs/en/api/device-api/inspect.mdx b/src/content/docs/en/api/device-api/inspect.mdx new file mode 100644 index 000000000..5105305dd --- /dev/null +++ b/src/content/docs/en/api/device-api/inspect.mdx @@ -0,0 +1,81 @@ +--- +title: "Inspect device endpoint" +description: "Use the Inspect device endpoint to see information about a device. Provide your app ID and your device's advertising ID to return device and tracker information relating to the app." +slug: en/api/device-api/inspect +sidebar-position: 2 +--- + +Use the Inspect device endpoint to see information about a device. Provide your app ID and your device's advertising ID to return device and tracker information relating to the app. + +## Endpoint + +``` +https://api.adjust.com/device_service/api/v1/inspect_device +``` + +### GET request + +Return device information as a JSON object. + +- - Parameter + - Data type + - In + - Description +- - `app_token`\* + - String + - Query + - Your app's 12 digit identifier +- - `advertising_id`\* + - String + - Query + - The device's unique advertising ID: + - `idfa` (iOS devices) + - `gps_adid` (Google advertising ID) + - `android_id` (Android ID) + - `fire_adid` (Amazon Fire ID) + - `win_adid` (Windows advertising ID) + +```json +{ + "Adid": "string", + "AdvertisingId": "string", + "Tracker": "string", + "TrackerName": "string", + "ClickTime": "date-time", + "InstallTime": "date-time", + "LastSessionTime": "date-time", + "LastEventTimes": { + "string": "date-time", + "string": "date-time", + "string": "date-time", + "string": "date-time" + }, + "State": "string" +} +``` + +## Example + +```console +$ curl --location --request GET "https://api.adjust.com/device_service/api/v1/inspect_device?advertising_id=1234-5678-9012-3456&app_token=gwzpeepw8uf8" \ +--header "Authorization: Bearer ask43jskdp2tg2hg87" +``` + +```json +{ + "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" +} +``` diff --git a/src/content/docs/en/api/index.mdx b/src/content/docs/en/api/index.mdx new file mode 100644 index 000000000..bf7e1adde --- /dev/null +++ b/src/content/docs/en/api/index.mdx @@ -0,0 +1,6 @@ +--- +title: "API documentation" +description: "Adjust API documentation" +category-title: API documentation +slug: en/api/index +--- From c479aa611ef4e1c8ae590129908da4188a0c753a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Mon, 7 Aug 2023 09:55:23 +0200 Subject: [PATCH 2/9] fix: Use new callout component --- src/content/docs/en/api/device-api/forget.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/docs/en/api/device-api/forget.mdx b/src/content/docs/en/api/device-api/forget.mdx index 36b67e57e..c7965ce4e 100644 --- a/src/content/docs/en/api/device-api/forget.mdx +++ b/src/content/docs/en/api/device-api/forget.mdx @@ -7,12 +7,12 @@ sidebar-position: 3 Use the Adjust forget device endpoint to clear device history from Adjust and test multiple installs on the same device. - + ## Endpoint From 815183e48fe5b7a9031109652f02347ef5129589 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Tue, 8 Aug 2023 16:14:46 +0200 Subject: [PATCH 3/9] feat: use ListTable component --- src/content/docs/en/api/device-api/forget.mdx | 8 ++++++++ src/content/docs/en/api/device-api/inspect.mdx | 4 ++++ 2 files changed, 12 insertions(+) diff --git a/src/content/docs/en/api/device-api/forget.mdx b/src/content/docs/en/api/device-api/forget.mdx index c7965ce4e..ed632c36e 100644 --- a/src/content/docs/en/api/device-api/forget.mdx +++ b/src/content/docs/en/api/device-api/forget.mdx @@ -24,6 +24,8 @@ https://api.adjust.com/device_service/api/v1/forget_device Clears the device's information from Adjust. + + - - Parameter - Data type - In @@ -37,6 +39,10 @@ Clears the device's information from Adjust. - Data - The device's Adjust ID + + + + - - Response - Message - Description @@ -44,6 +50,8 @@ Clears the device's information from Adjust. - Forgot device - Success response + + ## Example ```console diff --git a/src/content/docs/en/api/device-api/inspect.mdx b/src/content/docs/en/api/device-api/inspect.mdx index 5105305dd..6fe12dc55 100644 --- a/src/content/docs/en/api/device-api/inspect.mdx +++ b/src/content/docs/en/api/device-api/inspect.mdx @@ -17,6 +17,8 @@ https://api.adjust.com/device_service/api/v1/inspect_device Return device information as a JSON object. + + - - Parameter - Data type - In @@ -35,6 +37,8 @@ Return device information as a JSON object. - `fire_adid` (Amazon Fire ID) - `win_adid` (Windows advertising ID) + + ```json { "Adid": "string", From 8c89336b7951c997e56dcba8df8eb4cf6a569778 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Tue, 8 Aug 2023 16:41:44 +0200 Subject: [PATCH 4/9] feat: add formatting to forget device --- src/content/docs/en/api/device-api/forget.mdx | 28 +++++++++++-------- 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/src/content/docs/en/api/device-api/forget.mdx b/src/content/docs/en/api/device-api/forget.mdx index ed632c36e..556b00c38 100644 --- a/src/content/docs/en/api/device-api/forget.mdx +++ b/src/content/docs/en/api/device-api/forget.mdx @@ -7,7 +7,7 @@ sidebar-position: 3 Use the Adjust forget device endpoint to clear device history from Adjust and test multiple installs on the same device. - + You need **Admin** or **Editor** permissions to forget devices. If you have **Custom editor** permissions, you need to have edit rights for the app you are targeting. See [User @@ -41,17 +41,6 @@ Clears the device's information from Adjust. - - -- - Response - - Message - - Description -- - 200 - - Forgot device - - Success response - - - ## Example ```console @@ -63,3 +52,18 @@ $ curl --location --request POST "https://api.adjust.com/device_service/api/v1/f ```console Forgot device ``` + + + + + +- - Response + - Message + - Description +- - 200 + - Forgot device + - Success response + + + + From 98390dddc50a7e078829299274cff85c216a017e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Tue, 8 Aug 2023 16:42:24 +0200 Subject: [PATCH 5/9] feat: add authentication information and snippets --- .../docs/en/api/device-api/authentication.mdx | 4 ++ .../docs/en/api/partials/_Authentication.mdx | 71 +++++++++++++++++++ tsconfig.json | 3 +- 3 files changed, 77 insertions(+), 1 deletion(-) create mode 100644 src/content/docs/en/api/partials/_Authentication.mdx diff --git a/src/content/docs/en/api/device-api/authentication.mdx b/src/content/docs/en/api/device-api/authentication.mdx index 1bf67de37..ce84f5e30 100644 --- a/src/content/docs/en/api/device-api/authentication.mdx +++ b/src/content/docs/en/api/device-api/authentication.mdx @@ -9,3 +9,7 @@ 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. ## Before you begin + +import Authentication from "@content/en/api/partials/_Authentication.mdx"; + + diff --git a/src/content/docs/en/api/partials/_Authentication.mdx b/src/content/docs/en/api/partials/_Authentication.mdx new file mode 100644 index 000000000..023236b0b --- /dev/null +++ b/src/content/docs/en/api/partials/_Authentication.mdx @@ -0,0 +1,71 @@ +## 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. + + + If you've configured SSO, your API tokens aren't available in the Adjust + dashboard. Reach out to your Adjust representative or{" "} + support@adjust.com for help with API + tokens. + + +### Adjust Suite + +Your Adjust API token is located in your **profile**. To find it, follow these steps: + +1. Select the settings icon () in the bottom left corner. +2. Select **Account settings**. Your account settings page opens. +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. + +### Classic dashboard + +Your Adjust API token is located with your user details. If you're an **admin** user, follow these steps: + +1. Log in to the Classic dashboard. +2. Select the menu icon in the top left. +3. Select **My Account**. +4. In the **Your Data** tab, find the **User Details** section. Select the cog icon () at the bottom of this segment. +5. Select **API Token**. +6. Copy your API token from the **API Token** panel. + +If you're a **non-admin** user, follow these steps: + +1. Log in to the Classic dashboard. +2. Select the menu icon in the top left. +3. Select **My Profile**. +4. Select **API Token**. +5. Copy your API token from the **API Token** panel. + +## 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 will not work. If you reset your Adjust API token, you need to make sure to update it wherever it is in use. + +### Adjust Suite + +1. Select the settings icon () in the bottom left corner. +2. Select **Account settings**. Your account settings page opens. +3. Select the **My profile** tab. +4. Your **API token** is shown with your **User details**. +5. Select **Reset API token**. A popup modal appears. +6. Enter your account password in the modal and select **Reset** to reset your API token. The modal closes and 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. + +### Classic dashboard + +If you're an **admin** user, follow these steps: + +1. Log in to the Classic dashboard. +2. Select the menu icon in the top left. +3. Select **My Account**. +4. In the **Your Data** tab, find the **User Details** section. Select the cog icon () at the bottom of this segment. +5. Select **API Token**. +6. Select **Reset**. + +If you're a **non-admin** user, follow these steps: + +1. Log in to the Classic dashboard. +2. Select the menu icon in the top left. +3. Select **My Profile**. +4. Select **API Token**. +5. Select **Reset**. diff --git a/tsconfig.json b/tsconfig.json index 3113353a6..f65211d51 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -8,7 +8,8 @@ "baseUrl": ".", "allowImportingTsExtensions": true, "paths": { - "@components/*": ["src/components/*"] + "@components/*": ["src/components/*"], + "@content/*": ["src/content/docs/*"] } } } From 42ddd29209293f5263bd3e2ceb06b63f2c9584c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Tue, 8 Aug 2023 16:57:18 +0200 Subject: [PATCH 6/9] feat: use ATLAS icons in authentication document --- .../docs/en/api/partials/_Authentication.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/content/docs/en/api/partials/_Authentication.mdx b/src/content/docs/en/api/partials/_Authentication.mdx index 023236b0b..f4287ca79 100644 --- a/src/content/docs/en/api/partials/_Authentication.mdx +++ b/src/content/docs/en/api/partials/_Authentication.mdx @@ -13,10 +13,10 @@ Before you can start making API calls, you first need to find your Adjust API to Your Adjust API token is located in your **profile**. To find it, follow these steps: -1. Select the settings icon () in the bottom left corner. +1. Select the settings icon () in the bottom left corner. 2. Select **Account settings**. Your account settings page opens. 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. +4. Your **API token** is shown with your **User details**. Select the copy button () to copy the token to your system clipboard. ### Classic dashboard @@ -25,7 +25,7 @@ Your Adjust API token is located with your user details. If you're an **admin** 1. Log in to the Classic dashboard. 2. Select the menu icon in the top left. 3. Select **My Account**. -4. In the **Your Data** tab, find the **User Details** section. Select the cog icon () at the bottom of this segment. +4. In the **Your Data** tab, find the **User Details** section. Select the cog icon () at the bottom of this segment. 5. Select **API Token**. 6. Copy your API token from the **API Token** panel. @@ -39,17 +39,17 @@ If you're a **non-admin** user, follow these steps: ## 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 will not work. If you reset your Adjust API token, you need to make sure to update it wherever it is in use. +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. ### Adjust Suite -1. Select the settings icon () in the bottom left corner. +1. Select the settings icon () in the bottom left corner. 2. Select **Account settings**. Your account settings page opens. 3. Select the **My profile** tab. 4. Your **API token** is shown with your **User details**. 5. Select **Reset API token**. A popup modal appears. 6. Enter your account password in the modal and select **Reset** to reset your API token. The modal closes and 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. +7. Select the copy button () next to the **API token** to copy the token to your system clipboard. ### Classic dashboard @@ -58,7 +58,7 @@ If you're an **admin** user, follow these steps: 1. Log in to the Classic dashboard. 2. Select the menu icon in the top left. 3. Select **My Account**. -4. In the **Your Data** tab, find the **User Details** section. Select the cog icon () at the bottom of this segment. +4. In the **Your Data** tab, find the **User Details** section. Select the cog icon () at the bottom of this segment. 5. Select **API Token**. 6. Select **Reset**. From 368a639e6114d5256e3f0891043d49d4454c7993 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Wed, 16 Aug 2023 10:22:59 +0200 Subject: [PATCH 7/9] docs: update guilabel syntax to fix linting --- .vale.ini | 1 - .../docs/en/api/partials/_Authentication.mdx | 46 +++++++++---------- 2 files changed, 23 insertions(+), 24 deletions(-) diff --git a/.vale.ini b/.vale.ini index b9fe7a74f..f5e1f46cc 100644 --- a/.vale.ini +++ b/.vale.ini @@ -11,5 +11,4 @@ mdx = md BasedOnStyles = Microsoft,Adjust BlockIgnores = (?s) *(.*?), \ (?s) *(.*?), \ -(?s) *<(.*?)>, \ (?s) *(\x60\x60\x60[a-z]*[\s\S]*?\n\x60\x60\x60) diff --git a/src/content/docs/en/api/partials/_Authentication.mdx b/src/content/docs/en/api/partials/_Authentication.mdx index f4287ca79..33e4c9704 100644 --- a/src/content/docs/en/api/partials/_Authentication.mdx +++ b/src/content/docs/en/api/partials/_Authentication.mdx @@ -14,9 +14,9 @@ Before you can start making API calls, you first need to find your Adjust API to Your Adjust API token is located in your **profile**. To find it, follow these steps: 1. Select the settings icon () in the bottom left corner. -2. Select **Account settings**. Your account settings page opens. -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. +2. Select Account settings. Your account settings page opens. +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. ### Classic dashboard @@ -24,18 +24,18 @@ Your Adjust API token is located with your user details. If you're an **admin** 1. Log in to the Classic dashboard. 2. Select the menu icon in the top left. -3. Select **My Account**. -4. In the **Your Data** tab, find the **User Details** section. Select the cog icon () at the bottom of this segment. -5. Select **API Token**. -6. Copy your API token from the **API Token** panel. +3. Select My Account. +4. In the Your Data tab, find the User Details section. Select the cog icon () at the bottom of this segment. +5. Select API Token. +6. Copy your API token from the API Token panel. If you're a **non-admin** user, follow these steps: 1. Log in to the Classic dashboard. 2. Select the menu icon in the top left. -3. Select **My Profile**. -4. Select **API Token**. -5. Copy your API token from the **API Token** panel. +3. Select My Profile. +4. Select API Token. +5. Copy your API token from the API Token panel. ## Reset your Adjust API token @@ -44,12 +44,12 @@ You can reset your Adjust API token at any time. Resetting your token invalidate ### Adjust Suite 1. Select the settings icon () in the bottom left corner. -2. Select **Account settings**. Your account settings page opens. -3. Select the **My profile** tab. -4. Your **API token** is shown with your **User details**. -5. Select **Reset API token**. A popup modal appears. -6. Enter your account password in the modal and select **Reset** to reset your API token. The modal closes and 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. +2. Select Account settings. Your account settings page opens. +3. Select the My Profile tab. +4. Your API Token is shown with your User details. +5. Select Reset API token. A popup modal appears. +6. Enter your account password in the modal and select Reset to reset your API token. The modal closes and 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. ### Classic dashboard @@ -57,15 +57,15 @@ If you're an **admin** user, follow these steps: 1. Log in to the Classic dashboard. 2. Select the menu icon in the top left. -3. Select **My Account**. -4. In the **Your Data** tab, find the **User Details** section. Select the cog icon () at the bottom of this segment. -5. Select **API Token**. -6. Select **Reset**. +3. Select My Account. +4. In the Your Data tab, find the User Details section. Select the cog icon () at the bottom of this segment. +5. Select API Token. +6. Select Reset. If you're a **non-admin** user, follow these steps: 1. Log in to the Classic dashboard. 2. Select the menu icon in the top left. -3. Select **My Profile**. -4. Select **API Token**. -5. Select **Reset**. +3. Select My Profile. +4. Select API Token. +5. Select Reset. From c3284132a86405ff9e6916b7ead81ea6e7486b1a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Fri, 1 Sep 2023 13:08:38 +0200 Subject: [PATCH 8/9] feat: remove classic dash instructions --- .../docs/en/api/partials/_Authentication.mdx | 47 +------------------ 1 file changed, 1 insertion(+), 46 deletions(-) diff --git a/src/content/docs/en/api/partials/_Authentication.mdx b/src/content/docs/en/api/partials/_Authentication.mdx index 33e4c9704..345836e70 100644 --- a/src/content/docs/en/api/partials/_Authentication.mdx +++ b/src/content/docs/en/api/partials/_Authentication.mdx @@ -3,14 +3,9 @@ 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. - If you've configured SSO, your API tokens aren't available in the Adjust - dashboard. Reach out to your Adjust representative or{" "} - support@adjust.com for help with API - tokens. +If you've configured SSO, your API tokens aren't available in the Adjust dashboard. Reach out to your Adjust representative or support@adjust.com for help with API tokens. -### Adjust Suite - Your Adjust API token is located in your **profile**. To find it, follow these steps: 1. Select the settings icon () in the bottom left corner. @@ -18,31 +13,10 @@ Your Adjust API token is located in your **profile**. To find it, follow these s 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. -### Classic dashboard - -Your Adjust API token is located with your user details. If you're an **admin** user, follow these steps: - -1. Log in to the Classic dashboard. -2. Select the menu icon in the top left. -3. Select My Account. -4. In the Your Data tab, find the User Details section. Select the cog icon () at the bottom of this segment. -5. Select API Token. -6. Copy your API token from the API Token panel. - -If you're a **non-admin** user, follow these steps: - -1. Log in to the Classic dashboard. -2. Select the menu icon in the top left. -3. Select My Profile. -4. Select API Token. -5. Copy your API token from the API Token panel. - ## 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. -### Adjust Suite - 1. Select the settings icon () in the bottom left corner. 2. Select Account settings. Your account settings page opens. 3. Select the My Profile tab. @@ -50,22 +24,3 @@ You can reset your Adjust API token at any time. Resetting your token invalidate 5. Select Reset API token. A popup modal appears. 6. Enter your account password in the modal and select Reset to reset your API token. The modal closes and 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. - -### Classic dashboard - -If you're an **admin** user, follow these steps: - -1. Log in to the Classic dashboard. -2. Select the menu icon in the top left. -3. Select My Account. -4. In the Your Data tab, find the User Details section. Select the cog icon () at the bottom of this segment. -5. Select API Token. -6. Select Reset. - -If you're a **non-admin** user, follow these steps: - -1. Log in to the Classic dashboard. -2. Select the menu icon in the top left. -3. Select My Profile. -4. Select API Token. -5. Select Reset. From 465ecf2cde79d4c8cb45ee0d1180f8572de83c4c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Fri, 1 Sep 2023 13:08:49 +0200 Subject: [PATCH 9/9] feat: fix component headers --- src/content/docs/en/api/device-api/forget.mdx | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/content/docs/en/api/device-api/forget.mdx b/src/content/docs/en/api/device-api/forget.mdx index 556b00c38..007b87cd0 100644 --- a/src/content/docs/en/api/device-api/forget.mdx +++ b/src/content/docs/en/api/device-api/forget.mdx @@ -7,11 +7,11 @@ sidebar-position: 3 Use the Adjust forget device endpoint to clear device history from Adjust and test multiple installs on the same device. - - You need **Admin** or **Editor** permissions to forget devices. If you have - **Custom editor** permissions, you need to have edit rights for the app you - are targeting. See [User - permissions](https://help.adjust.com/en/article/users) for more information. + +### Before you begin + +You need **Admin** or **Editor** permissions to forget devices. If you have **Custom editor** permissions, you need to have edit rights for the app you are targeting. See [User permissions](https://help.adjust.com/en/article/users) for more information. + ## Endpoint @@ -53,7 +53,8 @@ $ curl --location --request POST "https://api.adjust.com/device_service/api/v1/f Forgot device ``` - + +### Responses