Configuring Scripts via the Civis API

Create scripts in SQL, Python, R or whatever language you want. You can query, modify, import, and export data. You can use the Civis API to orchestrate a workflow; creating and launching other processes, creating reports, etc.

SQL scripts will run on the Redshift cluster specified by the remoteHostId. Container scripts run in whatever docker image you supply. Python scripts will run in our datascience-python image and R scripts will run in the datascience-r image.

User Context 

Who will the script execute as:

• runner - The resources available to the script are those of the script runner. This is the default.
• author - The resources available to the script are those of the last runner of the script backing the template. If you publish a script with the user context of author, template runners will be calling the script with any credentials you supply and use your API key.

Parameters

Parameters can be added to a script so that it can be run with arguments and possibly published as a Template. To learn more about parameters, please see Script Parameters.

Templates and Custom Scripts

To share your script so that others may use it, publish your script as a Template. Others may then reference your template and plug in their own arguments for your parameters by creating a Custom Script.