The Alteryx API Tools are designed to allow users to interact with the Alteryx Gallery, via the use of the Alteryx Subscription and Admin APIs, in order to perform tasks that they may otherwise do within the interface. These tools may allow users to automate certain tasks, for example, administrators might want to download all workflows as packaged .zip files so that there contents can be programmatically reviewed for best practices.
The tools can be downloaded using the single Alteryx installer file (.yxi) stored in this github repository. Tools will be added to their own 'Alteryx API Tools' tool palette within your Alteryx Designer instance.
All tools have been designed to allow users to specify configuration parameters either dynamically from fields, or via fixed values entered in the configuration window.
Question: What is the 'Base URL' field
Answer: This is the address for which you use to navigate to your Alteryx Gallery via the web browser, it should look something like... https://mycompany.co.uk/gallery/ the trailing / is required!
The macro's in this section require 'Private Studio' API credentials and allow you to access items that you have published.
Allows you to get a list of workflows that exist within your private studio
Allows you to fetch the questions that create the interface for a given analytic application
Download workflows from your private studio
From a list of packaged workflow paths, unzip and read the underlying XML into Alteryx
This macro allows users to execute a workflow or application stored on Alteryx Server
Provides a method for running multiple workflows in a given order, depending on the status (success or fail) of the previous job.
Retrieves details of all jobs for a given workflow that were triggered via the Alteryx Subscription API
Fetches the status of a given job on Alteryx Server
The macro's in this section require Admin API credentials and allow you to access all assets on Alteryx Server, not just your own.
Retrieve a list of all users on the Alteryx Server
Get a list of all collections on the Alteryx Server
Create a list of all schedules on the Alteryx Server
Get a list of all workflows on the Alteryx Server
Get the latest job for all workflows
Create a forecast of all future jobs that are expected to run
Get a list of all insights on the Alteryx Server
Retrieve a list of all private studios on the Alteryx Server
Retrieve a list of all data connections on the Alteryx Server
Download any workflow on Alteryx Server
Allows you to publish a .yxzp to a given users private studio
Known Issues:
The 'Overwrite' functionality that this macro offers does not work, we have a support ticket open with Alteryx to understand where the issue lies.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent