AlteryxGalleryAPI is a python client helper used for connecting to the Alteryx Workflow Gallery.
It includes methods that can request Gallery information, send workflow execution commands, monitor job status, and retrieving the desired workflow output.
The official Alteryx API documentation can be found at: https://gallery.alteryx.com/api-docs/
In order to access the Gallery you must obtain an API key, secret and you must have the URL to your Alteryx Gallery.
You will need Poetry installed in your local python environment for local testing and development
Install the package by cloning the repository, "cd" into the populartimes directory and run poetry install.
Note: This library is not avaliable through via PyPI and must be installed locally and placed in your working directory.
#TODO: update the use process for httpx client methods
from AlteryxGallery import AlteryxGalleryAPI
client_key = 'your_client_key_here'
client_secret = 'your_client_secret_here'
gallery_url = 'your_gallery_url'
con = Gallery(gallery_url, client_key, client_secret)
GET request that returns all workflows in a subscription
endpoint = /v1/workflows/subscription
GET request that returns the questions for the given Alteryx Analytics App
endpoint = /v1/workflows/{appId}/questions/
POST request that queues an app execution job and returns ID of the job
endpoint = /v1/workflows/{appId}/jobs/
PAYLOAD PARAMETER IS OPTIONAL, ONLY NECESSARY IF YOUR APP HAS QUESTIONS
Payload Example:
date = datetime.strftime(datetime.now() - timedelta(1), '%Y-%m-%d')
values = {'questions': [{'name': 'TB_StartDate', 'value': date}, {'name': 'TB_EndDate', 'value': date}]}
con.executeWorkflow('5bc4a813156ae016dcb442bd', payload = values)
Non-Payload Example:
con.executeWorkflow('5bb78ffa6b2bdd1870007570')
GET request that returns the jobs for the given Alteryx Analytics App
endpoint = /v1/workflows/{appId}/jobs/
GET request that requires a jobID input and returns the status of that job
endpoint = /v1/jobs/{jobId}/
GET request that requires a jobID and an outputID which returns the output for a given job (FileURL)
endpoint = /v1/jobs/{jobId}/output/{outputId}/
GET request that returns the App that was requested
endpoint = /v1/jobs/{jobId}/output/{outputId}/
ls