Introduction to the API Explorer

[baileykaplan]

In this step-by-step activity, we’ll walk through how to use the Alteryx API Explorer, framed within a use case that demonstrates how to list workspace admins.

Note: Only Alteryx customers can access the API Explorer, but the Alteryx API Specs are publicly available to everyone.

1. Visit https://api-docs.us1.alteryxcloud.com/ and select Cloud API Specifications.

2. Navigate to the Identity and Access Management (IAM) APIs. These help you manage the users in your workspace.

3. From there, select the list admins for the specified workspace endpoint. You can read about the details of what is required to call this API in the Path Parameters and Query Parameters sections of the API Specs.

4. Now, we are going to try to test this API using the API Explorer. To start, you need to prove you are authorized to access this information. Click the Authorize button in the top-right corner, and then enter the name of the workspace you are using. You can find your workspace name in the upper right corner when you are logged into Alteryx Analytics Cloud.

   

   Select Authorize again. You may be prompted to log into the workspace. Once the pop-up loads, select OK.

   

   If you see Alteryx Analytics Cloud in the pop-up, you can X it out. If it says Authorization Failed, try repeating the process once more. You can now use the API Explorer!

   5. We can see that there is one required Path Parameter for this API, which is the workspaceID. This means you need to enter the workspaceID that you are using. If you are an account admin, you can find this information in the Account Admin Console, but there’s an easier way to do this via an API! In the API Specs, let’s navigate to the get information about the current workspace API. Since you’ve already authorized your credentials, all you have to do is hit Execute in the right-panel of the screen. This will run the API and return information about your current workspace. 

   The very first piece of information returned to me is the workspaceId.

   

   Let’s copy that integer and go back to our list admins for the specified workspace API.

   6. Write your workspaceId in the proper field, and hit Execute!

   

   7. You’ve just successfully used the API Explorer and run an API to return the workspace admins!