Civis API Python Client¶
The Civis API Python client is a Python package that helps analysts and developers interact with the Civis Platform. The package includes a set of tools around common workflows as well as a convenient interface to make requests directly to the Civis API.
Installation¶
The recommended install method is pip:
pip install civis
Alternatively, you may clone the code from github and build from source:
git clone https://github.com/civisanalytics/civis-python.git
cd civis-python
python setup.py install
The client has a soft dependency on pandas to support features such as
data type parsing. If you are using the io namespace to read or write
data from Civis, it is highly recommended that you install pandas and
set use_pandas=True in functions that accept that parameter. To install
pandas:
pip install pandas
Authentication¶
In order to make requests to the Civis API, you will need an API key that is
unique to you. Instructions for creating a new key are found here:
https://civis.zendesk.com/hc/en-us/articles/216341583-Generating-an-API-Key.
By default, the Python client will look for your key in the environment
variable CIVIS_API_KEY. To add the API key to your environment, copy
the key you generated to your clipboard and follow the instructions below
for your operating system.
Mac
Open .bash_profile in TextEdit:
cd ~/
touch .bash_profile
open -e .bash_profile
Then add the following line, replacing api_key_here with your key:
export CIVIS_API_KEY="api_key_here"
Linux
Open .bash_profile in your favorite editor (nano is used here):
cd ~/
nano .bash_profile
Then add the following line, replacing api_key_here with your key:
export CIVIS_API_KEY="api_key_here"
User Guide¶
For a more detailed walkthrough, see the User Guide.
Client API Reference¶
User Guide¶
Getting Started¶
After installing the Civis API Python client and setting up your API key, you
can now import the package civis:
>>> import civis
There are two entrypoints for working with the Civis API. The first is
the civis namespace, which contains tools for typical workflows in a user
friendly manner. For example, you may want to perform some transformation on
your data in Python that might be tricky to code in SQL. This code downloads
data from Civis, calculates the correlation between all the columns and then
uploads the data back into Civis:
>>> df = civis.io.read_civis(table="my_schema.my_table",
... database="database",
... use_pandas=True)
>>> correlation_matrix = df.corr()
>>> correlation_matrix["corr_var"] = correlation_matrix.index
>>> fut = civis.io.dataframe_to_civis(df=correlation_matrix,
... database="database",
... table="my_schema.my_correlations")
>>> fut.result()
Civis Futures¶
In the code above, dataframe_to_civis() returns a special
CivisFuture object. Making a request to the Civis
API usually results in a long running job. To account for this, various
functions in the civis namespace return a
CivisFuture to allow you to
process multiple long running jobs simultaneously. For instance, you may
want to start many jobs in parallel and wait for them all to finish rather
than wait for each job to finish before starting the next one.
The CivisFuture follows the
concurrent.futures.Future API fairly closely. For example,
calling result() on fut above forces the program to wait for the
job started with dataframe_to_civis() to finish and
returns the result.
Working Directly with the Client¶
Although many common workflows are included in the Civis API Python client,
projects often require direct calls to the Civis API. For convenience,
the Civis API Python client implements an APIClient object
to make these API calls with Python syntax rather than a manually crafted HTTP
request. To make a call, first instantiate an APIClient object:
>>> client = civis.APIClient()
Note
Creating an instance of APIClient makes an HTTP request to
determine the functions to attach to the object. You must have an
API key and internet connection to create an APIClient
object. By default, the functions attached to the object come from a base
set of Civis API endpoints. Based on your user profile, you may have access
to a set of developmental endpoints. To access these, instantiate the
client with client = civis.APIClient(resources='all').
With the client object instantiated, you can now make API requests like listing your user information:
>>> client.users.list_me()
{'email': 'user@email.com',
'feature_flags': {'left_nav_basic': True,
'results': True,
'scripts_notify': True,
'table_person_matching': True},
'id': 1,
'initials': 'UN',
'name': 'User Name',
'username': 'uname'}
Suppose we did not have the civis.io namespace. This is how we might export
a CSV file from Civis. As you will see, this can be quite involved and the
civis namespace entrypoint should be preferred whenever possible.
First, we get the ID for our database then we get the default credential for the current user.
>>> db_id = client.get_database_id('cluster-name')
>>> cred_id = client.default_credential
In order to export a table, we need to write some SQL that will generate the data to export. Then we create the export job and run it.
>>> generate_table = "select * from schema.tablename"
>>> export_job = client.scripts.post_sql(name="our export job",
remote_host_id=db_id,
credential_id=cred_id,
sql=generate_table)
>>> export_run = client.scripts.post_sql_runs(export_job.id)
We can then poll and wait for the export to be completed.
>>> import time
>>> export_state = client.scripts.get_sql_runs(export_job.id,
... export_run.id)
>>> while export_state.state in ['queued', 'running']:
... time.sleep(60)
... export_state = client.scripts.get_sql_runs(export_job.id,
... export_run.id)
Now, we can get the URL of the exported csv. First, we grab the result of our export job.
>>> export_result = client.scripts.get_sql_runs(export_job.id,
... export_run.id)
In the future, a script may export multiple jobs, so the output of this is a list.
The path returned will have a gzipped csv file, which we could load, for example, with pandas.
>>> url = export_result.output[0].path
Data Import and Export¶
The civis.io namespace provides several functions for moving data in and
out of Civis.
Tables¶
Often, your data will be in structured format like a table in a relational database, a CSV or a dataframe. The following functions handle moving structured data to and from Civis. When using these functions, it is recommended to have pandas installed and to pass use_pandas=True in the appropriate functions. If pandas is not installed, data returned from Civis will all be treated as strings.
civis_to_csv(filename, sql, database[, ...]) |
Export data from Civis to a local CSV file. |
csv_to_civis(filename, database, table[, ...]) |
Upload the contents of a local CSV file to Civis. |
dataframe_to_civis(df, database, table[, ...]) |
Upload a pandas DataFrame into a Civis table. |
read_civis(table, database[, columns, ...]) |
Read data from a Civis table. |
read_civis_sql(sql, database[, use_pandas, ...]) |
Read data from Civis using a custom SQL string. |
Files¶
These functions will pass flat files to and from Civis. This is useful if you have data stored in binary or JSON format. Any type of file can be stored in platform via the files endpoint.
civis_to_file(file_id, buf[, api_key]) |
Download a file from Civis. |
file_to_civis(buf, name[, api_key]) |
Upload a file to Civis. |
Databases¶
These functions move data from one database to another and expose an interface
to run SQL in the database. Use query_civis() when you need to
execute SQL that does not return data (for example, a GRANT or
DROP TABLE statement).
transfer_table(source_db, dest_db, ...[, ...]) |
Transfer a table from one location to another. |
query_civis(sql, database[, api_key, ...]) |
Execute a SQL statement as a Civis query. |
API Client¶
APIClient is a class for handling requests to the Civis API.
An instantiated APIClient contains a set of resources
(listed below) where each resource is an object with methods. By convention,
an instantiated APIClient object is named client and API
requests are made with the following syntax:
client = civis.APIClient()
response = client.resource.method(params)
-
class
civis.APIClient(api_key=None, return_type='snake', retry_total=6, api_version='1.0', resources='base')¶ The Civis API client.
Parameters: api_key : str, optional
Your API key obtained from the Civis Platform. If not given, the client will use the
CIVIS_API_KEYenvironment variable.return_type : str, optional
The following types are implemented:
'raw'Returns the rawrequests.Responseobject.'snake'Returns acivis.response.Responseobject for the json-encoded content of a response. This maps the top-level json keys to snake_case.'pandas'Returns apandas.DataFramefor list-like responses and apandas.Seriesfor single a json response.
retry_total : int, optional
A number indicating the maximum number of retries for 429, 502, 503, or 504 errors.
api_version : string, optional
The version of endpoints to call. May instantiate multiple client objects with different versions. Currently only “1.0” is supported.
resources : string, optional
When set to “base”, only the default endpoints will be exposed in the client object. Set to “all” to include all endpoints available for a given user, including those that may be in development and subject to breaking changes at a later date.
Attributes
credentials An instance of the Credentialsendpointdatabases An instance of the Databasesendpointfiles An instance of the Filesendpointimports An instance of the Importsendpointjobs An instance of the Jobsendpointmodels An instance of the Modelsendpointpredictions An instance of the Predictionsendpointprojects An instance of the Projectsendpointqueries An instance of the Queriesendpointreports An instance of the Reportsendpointscripts An instance of the Scriptsendpointtables An instance of the Tablesendpointusers An instance of the Usersendpoint-
default_credential¶ The current user’s default credential.
-
get_aws_credential_id(cred_name, owner=None)¶ Find an AWS credential ID.
Parameters: cred_name : str or int
If an integer ID is given, this passes through directly. If a str is given, return the ID corresponding to the AWS credential with that name.
owner : str, optional
Return the credential with this owner. If not provided, search for credentials under your username to disambiguate multiple credentials with the same name. Note that this function cannot return credentials which are not associated with an owner.
Returns: aws_credential_id : int
The ID number of the AWS credentials.
Raises: ValueError
If the AWS credential can’t be found.
Examples
>>> import civis >>> client = civis.APIClient() >>> client.get_aws_credential_id('jsmith') 1234
>>> client.get_aws_credential_id(1111) 1111
>>> client.get_aws_credential_id('shared-cred', ... owner='research-group') 99
-
get_database_credential_id(username, database_name)¶ Return the credential ID for a given username in a given database.
Parameters: username : str or int
If an integer ID is given, this passes through directly. If a str is given, return the ID corresponding to the database credential with that username.
database_name : str or int
Return the ID of the database credential with username username for this database name or ID.
Returns: database_credential_id : int
The ID of the database credentials.
Raises: ValueError
If the credential can’t be found.
Examples
>>> import civis >>> client = civis.APIClient() >>> client.get_database_credential_id('jsmith', 'redshift-general') 1234
>>> client.get_database_credential_id(1111, 'redshift-general') 1111
-
get_database_id(database)¶ Return the database ID for a given database name.
Parameters: database : str or int
If an integer ID is given, passes through. If a str is given the database ID corresponding to that database name is returned.
Returns: database_id : int
The ID of the database.
Raises: ValueError
If the database can’t be found.
-
get_table_id(table, database)¶ Return the table ID for a given database and table name.
Parameters: table : str
The name of the table in format schema.table.
database : str or int
The name or ID of the database.
Returns: table_id : int
The ID of the table. Only returns exact match to specified table.
Raises: ValueError
If an exact table match can’t be found.
-
username¶ The current user’s username.
API Response Types¶
-
class
civis.response.Response(json_data, snake_case=True, headers=None)¶ Custom Civis response object.
Notes
The main features of this class are that it maps camelCase to snake_case at the top level of the json object and attaches keys as attributes. Nested object keys are not changed.
Attributes
json_data (dict | None) This is json_data as it is originally returned to the user without the key names being changed. See Notes. None is used if the original response returned a 204 No Content response. headers (dict) This is the header for the API call without changing the key names. calls_remaining (int) Number of API calls remaining before rate limit is reached. rate_limit (int) Total number of calls per API rate limit period.
-
class
civis.response.PaginatedResponse(path, initial_params, endpoint)¶ A response object that supports iteration.
Parameters: path : str
Make GET requests to this path.
initial_params : dict
Query params that should be passed along with each request. Note that if initial_params contains the keys page_num or limit, they will be ignored. The given dict is not modified.
endpoint : civis.base.Endpoint
An endpoint used to make API requests.
Notes
This response is returned automatically by endpoints which support pagination when the iterator kwarg is specified.
Examples
>>> client = civis.APIClient() >>> queries = client.queries.list(iterator=True) >>> for query in queries: ... print(query['id'])
-
class
civis.polling.PollableResult(poller, poller_args, polling_interval=None, api_key=None, poll_on_creation=True)¶ Bases:
civis.base.CivisAsyncResultBaseA class for tracking pollable results.
This class will begin polling immediately upon creation, and poll for job completion once every polling_interval seconds until the job completes in Civis.
Parameters: poller : func
A function which returns an object that has a
stateattribute.poller_args : tuple
The arguments with which to call the poller function.
polling_interval : int or float
The number of seconds between API requests to check whether a result is ready.
api_key : str, optional
This is not used by PollableResult, but is required to match the interface from CivisAsyncResultBase.
poll_on_creation : bool, optional
If
True(the default), it will poll upon callingresult()the first time. IfFalse, it will wait the number of seconds specified in polling_interval from object creation before polling.Examples
>>> client = civis.APIClient() >>> database_id = client.get_database_id("my_database") >>> cred_id = client.default_credential >>> sql = "SELECT 1" >>> preview_rows = 10 >>> response = client.queries.post(database_id, sql, preview_rows, >>> credential=cred_id) >>> job_id = response.id >>> >>> poller = client.queries.get >>> poller_args = (job_id, ) # (job_id, run_id) if poller requires run_id >>> polling_interval = 10 >>> poll = PollableResult(poller, poller_args, polling_interval)
API Resources¶
Credentials¶
-
class
Credentials(session, return_type='civis')¶ Methods
get(id)Get a credential list(**kwargs)List credentials post(username, password, type, **kwargs)Create or update a credential post_authenticate(username, password, url, ...)Authenticate against a remote host post_temporary(id, **kwargs)Generate a temporary credential for accessing S3 put(id, username, password, type, **kwargs)Update an existing credential -
get(id)¶ Get a credential
Parameters: id : integer
The ID of the credential.
Returns: username : string
The username for the credential.
description : string
A long description of the credential.
remote_host_id : integer
The ID of the remote host associated with this credential.
owner : string
The name of the user who this credential belongs to.
remote_host_name : string
The name of the remote host associated with this credential.
id : integer
The ID of the credential.
created_at : string/time
The creation time for this credential.
type : string
The credential’s type.
name : string
The name identifying the credential
updated_at : string/time
The last modification time for this credential.
-
list(**kwargs)¶ List credentials
Parameters: type : string, optional
The type (or types) of credentials to return. One or more of: Amazon Web Services S3, BSD::API, CASS/NCOA PAF, Catalist::API, Catalist::SFTP, Certificate, Civis Platform, Custom, Database, Google, Github, JobTraits::Ftp, Salesforce User, Salesforce Client, Silverpop Application, Silverpop Refresh Token, Silverpop User, TableauUser, VAN::MyVoterFile, VAN::MyCampaign, and VAN::BothModes. Specify multiple values as a comma- separated list (e.g., “A,B”).
default : boolean, optional
If true, will return a list with a single credential which is the current user’s default credential.
limit : integer, optional
Number of results to return. Defaults to its maximum of 1000.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: username : string
The username for the credential.
description : string
A long description of the credential.
remote_host_id : integer
The ID of the remote host associated with this credential.
owner : string
The name of the user who this credential belongs to.
remote_host_name : string
The name of the remote host associated with this credential.
id : integer
The ID of the credential.
created_at : string/time
The creation time for this credential.
type : string
The credential’s type.
name : string
The name identifying the credential
updated_at : string/time
The last modification time for this credential.
-
post(username, password, type, **kwargs)¶ Create or update a credential
Parameters: username : string
The username for the credential.
password : string
The password for the credential.
type : string
description : string, optional
A long description of the credential.
remote_host_id : integer, optional
The ID of the remote host associated with the credential.
remote_host : dict, optional:
- type : string The type of remote host. One of: RemoteHostTypes::BSD, RemoteHostTypes::Ftp, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Redshift, RemoteHostTypes::Salesforce, and RemoteHostTypes::Van - url : string The URL to your host. - name : string The human readable name for the remote host.
name : string, optional
The name identifying the credential.
Returns: username : string
The username for the credential.
description : string
A long description of the credential.
remote_host_id : integer
The ID of the remote host associated with this credential.
owner : string
The name of the user who this credential belongs to.
remote_host_name : string
The name of the remote host associated with this credential.
id : integer
The ID of the credential.
created_at : string/time
The creation time for this credential.
type : string
The credential’s type.
name : string
The name identifying the credential
updated_at : string/time
The last modification time for this credential.
-
post_authenticate(username, password, url, remote_host_type)¶ Authenticate against a remote host
Parameters: username : string
The username for the credential.
password : string
The password for the credential.
url : string
The URL to your host.
remote_host_type : string
The type of remote host. One of: RemoteHostTypes::BSD, RemoteHostTypes::Ftp, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Redshift, RemoteHostTypes::Salesforce, and RemoteHostTypes::Van
Returns: username : string
The username for the credential.
description : string
A long description of the credential.
remote_host_id : integer
The ID of the remote host associated with this credential.
owner : string
The name of the user who this credential belongs to.
remote_host_name : string
The name of the remote host associated with this credential.
id : integer
The ID of the credential.
created_at : string/time
The creation time for this credential.
type : string
The credential’s type.
name : string
The name identifying the credential
updated_at : string/time
The last modification time for this credential.
-
post_temporary(id, **kwargs)¶ Generate a temporary credential for accessing S3
Parameters: id : integer
The ID of the credential.
duration : integer, optional
The number of seconds the temporary credential should be valid. Defaults to 15 minutes. Must not be less than 15 minutes or greater than 36 hours.
Returns: secret_access_key : string
The secret part of the credential.
access_key : string
The identifier of the credential.
session_token : string
The session token identifier.
-
put(id, username, password, type, **kwargs)¶ Update an existing credential
Parameters: id : integer
The ID of the credential.
username : string
The username for the credential.
password : string
The password for the credential.
type : string
description : string, optional
A long description of the credential.
remote_host_id : integer, optional
The ID of the remote host associated with the credential.
remote_host : dict, optional:
- type : string The type of remote host. One of: RemoteHostTypes::BSD, RemoteHostTypes::Ftp, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Redshift, RemoteHostTypes::Salesforce, and RemoteHostTypes::Van - url : string The URL to your host. - name : string The human readable name for the remote host.
name : string, optional
The name identifying the credential.
Returns: username : string
The username for the credential.
description : string
A long description of the credential.
remote_host_id : integer
The ID of the remote host associated with this credential.
owner : string
The name of the user who this credential belongs to.
remote_host_name : string
The name of the remote host associated with this credential.
id : integer
The ID of the credential.
created_at : string/time
The creation time for this credential.
type : string
The credential’s type.
name : string
The name identifying the credential
updated_at : string/time
The last modification time for this credential.
-
Databases¶
-
class
Databases(session, return_type='civis')¶ Methods
delete_whitelist_ips(id, whitelisted_ip_id)Remove a whitelisted IP address get_whitelist_ips(id, whitelisted_ip_id)View details about a whitelisted IP list()List databases list_schemas(id)List schemas in this database list_whitelist_ips(id)List whitelisted IPs for the specified database post_whitelist_ips(id, subnet_mask)Whitelist an IP address -
delete_whitelist_ips(id, whitelisted_ip_id)¶ Remove a whitelisted IP address
Parameters: id : integer
The ID of the database this rule is applied to.
whitelisted_ip_id : integer
The ID of this whitelisted IP address.
Returns: None
Response code 204: success
-
get_whitelist_ips(id, whitelisted_ip_id)¶ View details about a whitelisted IP
Parameters: id : integer
The ID of the database this rule is applied to.
whitelisted_ip_id : integer
The ID of this whitelisted IP address.
Returns: remote_host_id : integer
The ID of the database this rule is applied to.
updated_at : string/time
The time this rule was last updated.
created_at : string/time
The time this rule was created.
id : integer
The ID of this whitelisted IP address.
subnet_mask : string
The subnet mask that is allowed by this rule.
is_active : boolean
True if the rule is applied, false if it has been revoked.
authorized_by : string
The user who authorized this rule.
security_group_id : string
The ID of the security group this rule is applied to.
-
list()¶ List databases
Returns: name : string
The name of the database.
id : integer
The ID for the database.
-
list_schemas(id)¶ List schemas in this database
Parameters: id : integer
The ID of the database.
Returns: schema : string
The name of a schema.
-
list_whitelist_ips(id)¶ List whitelisted IPs for the specified database
Parameters: id : integer
The ID for the database.
Returns: remote_host_id : integer
The ID of the database this rule is applied to.
updated_at : string/time
The time this rule was last updated.
created_at : string/time
The time this rule was created.
id : integer
The ID of this whitelisted IP address.
subnet_mask : string
The subnet mask that is allowed by this rule.
security_group_id : string
The ID of the security group this rule is applied to.
-
post_whitelist_ips(id, subnet_mask)¶ Whitelist an IP address
Parameters: id : integer
The ID of the database this rule is applied to.
subnet_mask : string
The subnet mask that is allowed by this rule.
Returns: remote_host_id : integer
The ID of the database this rule is applied to.
updated_at : string/time
The time this rule was last updated.
created_at : string/time
The time this rule was created.
id : integer
The ID of this whitelisted IP address.
subnet_mask : string
The subnet mask that is allowed by this rule.
is_active : boolean
True if the rule is applied, false if it has been revoked.
authorized_by : string
The user who authorized this rule.
security_group_id : string
The ID of the security group this rule is applied to.
-
Files¶
-
class
Files(session, return_type='civis')¶ Methods
delete_projects(id, project_id)Remove a Data::S3File from a project delete_shares_groups(id, group_id)Revoke the permissions a group has on this object delete_shares_users(id, user_id)Revoke the permissions a user has on this object get(id)Get details about a file list_projects(id)List the projects a Data::S3File belongs to list_shares(id)List users and groups permissioned on this object post(name, **kwargs)Initiate an upload of a file into the platform put_projects(id, project_id)Add a Data::S3File to a project put_shares_groups(id, permission_level, ...)Set the permissions groups has on this object put_shares_users(id, user_ids, permission_level)Set the permissions users have on this object -
delete_projects(id, project_id)¶ Remove a Data::S3File from a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Revoke the permissions a group has on this object
Parameters: id : integer
ID of the resource to be revoked
group_id : integer
ID of the group
Returns: None
Response code 204: success
Revoke the permissions a user has on this object
Parameters: id : integer
ID of the resource to be revoked
user_id : integer
ID of the user
Returns: None
Response code 204: success
-
get(id)¶ Get details about a file
Parameters: id : integer
The ID of the file object.
Returns: download_url : string
A JSON string containing information about the URL of the file.
file_url : string
The URL that may be used to download the file.
created_at : string/date-time
The date and time the file was created.
file_size : integer
The file size.
expires_at : string/date-time
The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.
id : integer
The ID of the file object.
name : string
The file name.
-
list_projects(id)¶ List the projects a Data::S3File belongs to
Parameters: id : integer
The ID of the resource.
Returns: updated_at : string/time
description : string
A description of the project
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
id : integer
The ID for this project.
auto_share : boolean
archived : string
The archival status of the requested object(s).
name : string
The name of this project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
List users and groups permissioned on this object
Parameters: id : integer
The ID of the object.
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
post(name, **kwargs)¶ Initiate an upload of a file into the platform
Parameters: name : string
The file name.
expires_at : string/date-time, optional
The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.
Returns: upload_url : string
The URL that may be used to upload a file. To use the upload URL, initiate a POST request to the given URL with the file you wish to import as the “file” form field.
created_at : string/date-time
The date and time the file was created.
file_size : integer
The file size.
expires_at : string/date-time
The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.
id : integer
The ID of the file object.
name : string
The file name.
upload_fields : dict
A hash containing the form fields to be included with the POST request.
-
put_projects(id, project_id)¶ Add a Data::S3File to a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Set the permissions groups has on this object
Parameters: id : integer
ID of the resource to be shared
permission_level : string
Options are: “read”, “write”, or “manage”
group_ids : list
An array of one or more group IDs
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
Set the permissions users have on this object
Parameters: id : integer
ID of the resource to be shared
user_ids : list
An array of one or more user IDs
permission_level : string
Options are: “read”, “write”, or “manage”
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
Imports¶
-
class
Imports(session, return_type='civis')¶ Methods
delete_files_runs(id, run_id)Cancel a run delete_projects(id, project_id)Remove a JobTypes::Import from a project delete_shares_groups(id, group_id)Revoke the permissions a group has on this object delete_shares_users(id, user_id)Revoke the permissions a user has on this object delete_syncs(id, sync_id)Delete a sync get(id)Get details about an import get_batches(id)Get details about a batch import get_files_runs(id, run_id)Check status of a run list(**kwargs)List imports list_batches(**kwargs)List batch imports list_files_runs(id, **kwargs)List runs for the given import list_projects(id)List the projects a JobTypes::Import belongs to list_runs(id)Get the run history of this import list_shares(id)List users and groups permissioned on this object post(is_outbound, sync_type, name, **kwargs)Create a new import configuration post_batches(file_ids, table, ...)Upload multiple files to Redshift post_cancel(id)Cancel a run post_files(schema, credential_id, ...)Initate an import of a tabular file into the platform post_files_runs(id)Start a run post_runs(id)Run an import post_syncs(id, source, destination, **kwargs)Create a sync put(id, is_outbound, sync_type, name, **kwargs)Update an import put_archive(id, status)Update the archive status of this object put_projects(id, project_id)Add a JobTypes::Import to a project put_shares_groups(id, permission_level, ...)Set the permissions groups has on this object put_shares_users(id, user_ids, permission_level)Set the permissions users have on this object put_syncs(id, sync_id, source, destination, ...)Update a sync -
delete_files_runs(id, run_id)¶ Cancel a run
Parameters: id : integer
The ID of the import.
run_id : integer
The ID of the run.
Returns: None
Response code 202: success
-
delete_projects(id, project_id)¶ Remove a JobTypes::Import from a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Revoke the permissions a group has on this object
Parameters: id : integer
ID of the resource to be revoked
group_id : integer
ID of the group
Returns: None
Response code 204: success
Revoke the permissions a user has on this object
Parameters: id : integer
ID of the resource to be revoked
user_id : integer
ID of the user
Returns: None
Response code 204: success
-
delete_syncs(id, sync_id)¶ Delete a sync
Parameters: id : integer
The ID of the import to fetch.
sync_id : integer
The ID of the sync to fetch.
Returns: None
Response code 204: success
-
get(id)¶ Get details about an import
Parameters: id : integer
The ID for the import.
Returns: next_run_at : string/time
The time of the next scheduled run.
archived : string
The archival status of the requested object(s).
state : string
updated_at : string/date-time
id : integer
The ID for the import.
is_outbound : boolean
source : dict:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer - name : string
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
time_zone : string
The time zone of this import.
syncs : list:
List of syncs. - advanced_options : dict:: - sortkey2 : string - existing_table_rows : string - contact_lists : string - partition_schema_name : string - partition_table_partition_column_max_name : string - mysql_catalog_matches_schema : boolean - sortkey1 : string - distkey : string - partition_table_partition_column_min_name : string - invalid_char_replacement : string - partition_table_name : string - wipe_destination_table : boolean - export_action : string - identity_column : string - truncate_long_lines : boolean - sql_query : string - column_delimiter : string - max_errors : integer - partition_column_name : string - row_chunk_size : integer - soql_query : string - first_row_is_header : boolean - verify_table_row_counts : boolean - last_modified_column : string - source : dict:: - path : string The path of the dataset to sync from; for a database source, schema.tablename. - id : integer The ID of the table or file, if available. - destination : dict:: - path : string The schema.tablename to sync to. - id : integer
destination : dict:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer - name : string
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/date-time
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
sync_type : string
The type of sync to perform; one of Dbsync, AutoImport, SilverpopDataImport, SilverpopContactImport, GdocImport, GdocExport, and Salesforce.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer
Parent id to trigger this import from
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
The name of the import.
-
get_batches(id)¶ Get details about a batch import
Parameters: id : integer
The ID for the import.
Returns: table : string
The destination table name, without the schema prefix. This table must already exist in Redshift.
state : string
The state of the run; one of “queued”, “running”, “succeeded”, “failed”, or “cancelled”.
remote_host_id : integer
The ID of the destination database host.
id : integer
The ID for the import.
schema : string
The destination schema name. This schema must already exist in Redshift.
error : string
The error returned by the run, if any.
finished_at : string/time
The time the last run completed.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
started_at : string/time
The time the last run started at.
-
get_files_runs(id, run_id)¶ Check status of a run
Parameters: id : integer
The ID of the import.
run_id : integer
The ID of the run.
Returns: import_id : integer
The ID of the import.
state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
id : integer
The ID of the run.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
list(**kwargs)¶ List imports
Parameters: type : string, optional
If specified, return imports of these types. It accepts a comma-separated list, possible values are ‘AutoImport’, ‘DbSync’, ‘Salesforce’, ‘GdocImport’.
author : string, optional
If specified, return imports from this author. It accepts a comma-separated list of author ids.
destination : string, optional
If specified, returns imports with one of these destinations. It accepts a comma-separated list of remote host ids.
status : string, optional
If specified, returns imports with one of these statuses. It accepts a comma-separated list, possible values are ‘running’, ‘failed’, ‘succeeded’, ‘idle’, ‘scheduled’.
archived : string, optional
The archival status of the requested object(s).
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: state : string
updated_at : string/date-time
id : integer
The ID for the import.
is_outbound : boolean
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
time_zone : string
The time zone of this import.
destination : dict:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer - name : string
archived : string
The archival status of the requested object(s).
created_at : string/date-time
sync_type : string
The type of sync to perform; one of Dbsync, AutoImport, SilverpopDataImport, SilverpopContactImport, GdocImport, GdocExport, and Salesforce.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
source : dict:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer - name : string
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
The name of the import.
-
list_batches(**kwargs)¶ List batch imports
Parameters: limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: table : string
The destination table name, without the schema prefix. This table must already exist in Redshift.
state : string
The state of the run; one of “queued”, “running”, “succeeded”, “failed”, or “cancelled”.
remote_host_id : integer
The ID of the destination database host.
id : integer
The ID for the import.
schema : string
The destination schema name. This schema must already exist in Redshift.
error : string
The error returned by the run, if any.
finished_at : string/time
The time the last run completed.
started_at : string/time
The time the last run started at.
-
list_files_runs(id, **kwargs)¶ List runs for the given import
Parameters: id : integer
The ID of the import.
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 100.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to id. Must be one of: id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: import_id : integer
The ID of the import.
state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
id : integer
The ID of the run.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
list_projects(id)¶ List the projects a JobTypes::Import belongs to
Parameters: id : integer
The ID of the resource.
Returns: updated_at : string/time
description : string
A description of the project
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
id : integer
The ID for this project.
auto_share : boolean
archived : string
The archival status of the requested object(s).
name : string
The name of this project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
-
list_runs(id)¶ Get the run history of this import
Parameters: id : integer
Returns: state : string
created_at : string/time
The time that the run was queued.
id : integer
error : string
The error message for this run, if present.
finished_at : string/time
The time that the run completed.
started_at : string/time
The time that the run started.
List users and groups permissioned on this object
Parameters: id : integer
The ID of the object.
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
post(is_outbound, sync_type, name, **kwargs)¶ Create a new import configuration
Parameters: is_outbound : boolean
sync_type : string
The type of sync to perform; one of Dbsync, AutoImport, SilverpopDataImport, SilverpopContactImport, GdocImport, GdocExport, and Salesforce.
name : string
The name of the import.
next_run_at : string/time, optional
The time of the next scheduled run.
time_zone : string, optional
The time zone of this import.
destination : dict, optional:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer, optional
Parent id to trigger this import from
source : dict, optional:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
Returns: next_run_at : string/time
The time of the next scheduled run.
archived : string
The archival status of the requested object(s).
state : string
updated_at : string/date-time
id : integer
The ID for the import.
is_outbound : boolean
source : dict:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer - name : string
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
time_zone : string
The time zone of this import.
syncs : list:
List of syncs. - advanced_options : dict:: - sortkey2 : string - existing_table_rows : string - contact_lists : string - partition_schema_name : string - partition_table_partition_column_max_name : string - mysql_catalog_matches_schema : boolean - sortkey1 : string - distkey : string - partition_table_partition_column_min_name : string - invalid_char_replacement : string - partition_table_name : string - wipe_destination_table : boolean - export_action : string - identity_column : string - truncate_long_lines : boolean - sql_query : string - column_delimiter : string - max_errors : integer - partition_column_name : string - row_chunk_size : integer - soql_query : string - first_row_is_header : boolean - verify_table_row_counts : boolean - last_modified_column : string - source : dict:: - path : string The path of the dataset to sync from; for a database source, schema.tablename. - id : integer The ID of the table or file, if available. - destination : dict:: - path : string The schema.tablename to sync to. - id : integer
destination : dict:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer - name : string
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/date-time
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
sync_type : string
The type of sync to perform; one of Dbsync, AutoImport, SilverpopDataImport, SilverpopContactImport, GdocImport, GdocExport, and Salesforce.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer
Parent id to trigger this import from
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
The name of the import.
-
post_batches(file_ids, table, remote_host_id, schema, credential_id, **kwargs)¶ Upload multiple files to Redshift
Parameters: file_ids : list
The file IDs for the import.
table : string
The destination table name, without the schema prefix. This table must already exist in Redshift.
remote_host_id : integer
The ID of the destination database host.
schema : string
The destination schema name. This schema must already exist in Redshift.
credential_id : integer
The ID of the credentials to be used when performing the database import.
first_row_is_header : boolean, optional
A boolean value indicating whether or not the first row is a header row. If unspecified, defaults to false.
column_delimiter : string, optional
The column delimiter for the file. Valid arguments are “comma”, “tab”, and “pipe”. If unspecified, defaults to “comma”.
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
compression : string, optional
The type of compression. Valid arguments are “gzip”, “zip”, and “none”. If unspecified, defaults to “gzip”.
Returns: table : string
The destination table name, without the schema prefix. This table must already exist in Redshift.
state : string
The state of the run; one of “queued”, “running”, “succeeded”, “failed”, or “cancelled”.
remote_host_id : integer
The ID of the destination database host.
id : integer
The ID for the import.
schema : string
The destination schema name. This schema must already exist in Redshift.
error : string
The error returned by the run, if any.
finished_at : string/time
The time the last run completed.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
started_at : string/time
The time the last run started at.
-
post_cancel(id)¶ Cancel a run
Parameters: id : integer
The ID of the job.
Returns: is_cancel_requested : boolean
True if run cancel requested, else false.
state : string
The state of the run, one of ‘queued’, ‘running’ or ‘cancelled’.
id : integer
The ID of the run.
-
post_files(schema, credential_id, remote_host_id, name, **kwargs)¶ Initate an import of a tabular file into the platform
Parameters: schema : string
The schema of the destination table.
credential_id : integer
The id of the credentials to be used when performing the database import.
remote_host_id : integer
The id of the destination database host.
name : string
The name of the destination table.
sortkey2 : string, optional
The second column in a compound sortkey for the table.
existing_table_rows : string, optional
The behaviour if a table with the requested name already exists. One of “fail”, “truncate”, “append”, or “drop”.Defaults to “fail”.
multipart : boolean, optional
If true, the upload URI will require a multipart/form-data POST request. Defaults to false.
column_delimiter : string, optional
The column delimiter of the file. If column_delimiter is null or omitted, it will be auto-detected. Valid arguments are “comma”, “tab”, and “pipe”.
max_errors : integer, optional
The maximum number of rows with errors to remove from the import before failing.
sortkey1 : string, optional
The column to use as the sort key for the table.
distkey : string, optional
The column to use as the distkey for the table.
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
first_row_is_header : boolean, optional
A boolean value indicating whether or not the first row is a header row. If first_row_is_header is null or omitted, it will be auto-detected.
Returns: run_uri : string
The URI to POST to once the file upload is complete. After uploading the file using the URI given in the uploadUri attribute of the reponse, POST to this URI to initiate the import of your uploaded file into the platform.
upload_uri : string
The URI which may be used to upload a tabular file for import. You must use this URI to upload the file you wish imported and then inform the Civis API when your upload is complete using the URI given by the runUri field of this reponse.
upload_fields : dict
If multipart was set to true, these fields should be included in the multipart upload.
id : integer
The id of the import.
-
post_files_runs(id)¶ Start a run
Parameters: id : integer
The ID of the import.
Returns: import_id : integer
The ID of the import.
state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
id : integer
The ID of the run.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
post_runs(id)¶ Run an import
Parameters: id : integer
The ID of the import to run.
Returns: run_id : integer
The ID of the new run triggered.
-
post_syncs(id, source, destination, **kwargs)¶ Create a sync
Parameters: id : integer
source : dict:
- path : string The path of the dataset to sync from; for a database source, schema.tablename.
destination : dict:
- path : string The schema.tablename to sync to.
advanced_options : dict, optional:
- sortkey2 : string - existing_table_rows : string - contact_lists : string - partition_schema_name : string - partition_table_partition_column_max_name : string - mysql_catalog_matches_schema : boolean - sortkey1 : string - distkey : string - partition_table_partition_column_min_name : string - invalid_char_replacement : string - partition_table_name : string - wipe_destination_table : boolean - export_action : string - identity_column : string - truncate_long_lines : boolean - sql_query : string - column_delimiter : string - max_errors : integer - partition_column_name : string - row_chunk_size : integer - soql_query : string - first_row_is_header : boolean - verify_table_row_counts : boolean - last_modified_column : string
Returns: advanced_options : dict:
- sortkey2 : string - existing_table_rows : string - contact_lists : string - partition_schema_name : string - partition_table_partition_column_max_name : string - mysql_catalog_matches_schema : boolean - sortkey1 : string - distkey : string - partition_table_partition_column_min_name : string - invalid_char_replacement : string - partition_table_name : string - wipe_destination_table : boolean - export_action : string - identity_column : string - truncate_long_lines : boolean - sql_query : string - column_delimiter : string - max_errors : integer - partition_column_name : string - row_chunk_size : integer - soql_query : string - first_row_is_header : boolean - verify_table_row_counts : boolean - last_modified_column : string
source : dict:
- path : string The path of the dataset to sync from; for a database source, schema.tablename. - id : integer The ID of the table or file, if available.
destination : dict:
- path : string The schema.tablename to sync to.
id : integer
-
put(id, is_outbound, sync_type, name, **kwargs)¶ Update an import
Parameters: id : integer
The ID for the import.
is_outbound : boolean
sync_type : string
The type of sync to perform; one of Dbsync, AutoImport, SilverpopDataImport, SilverpopContactImport, GdocImport, GdocExport, and Salesforce.
name : string
The name of the import.
next_run_at : string/time, optional
The time of the next scheduled run.
time_zone : string, optional
The time zone of this import.
destination : dict, optional:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer, optional
Parent id to trigger this import from
source : dict, optional:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer
Returns: next_run_at : string/time
The time of the next scheduled run.
archived : string
The archival status of the requested object(s).
state : string
updated_at : string/date-time
id : integer
The ID for the import.
is_outbound : boolean
source : dict:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer - name : string
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
time_zone : string
The time zone of this import.
syncs : list:
List of syncs. - advanced_options : dict:: - sortkey2 : string - existing_table_rows : string - contact_lists : string - partition_schema_name : string - partition_table_partition_column_max_name : string - mysql_catalog_matches_schema : boolean - sortkey1 : string - distkey : string - partition_table_partition_column_min_name : string - invalid_char_replacement : string - partition_table_name : string - wipe_destination_table : boolean - export_action : string - identity_column : string - truncate_long_lines : boolean - sql_query : string - column_delimiter : string - max_errors : integer - partition_column_name : string - row_chunk_size : integer - soql_query : string - first_row_is_header : boolean - verify_table_row_counts : boolean - last_modified_column : string - source : dict:: - path : string The path of the dataset to sync from; for a database source, schema.tablename. - id : integer The ID of the table or file, if available. - destination : dict:: - path : string The schema.tablename to sync to. - id : integer
destination : dict:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer - name : string
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/date-time
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
sync_type : string
The type of sync to perform; one of Dbsync, AutoImport, SilverpopDataImport, SilverpopContactImport, GdocImport, GdocExport, and Salesforce.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer
Parent id to trigger this import from
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
The name of the import.
-
put_archive(id, status)¶ Update the archive status of this object
Parameters: id : integer
The ID of the object.
status : boolean
The desired archived status of the object.
Returns: next_run_at : string/time
The time of the next scheduled run.
archived : string
The archival status of the requested object(s).
state : string
updated_at : string/date-time
id : integer
The ID for the import.
is_outbound : boolean
source : dict:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer - name : string
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
time_zone : string
The time zone of this import.
syncs : list:
List of syncs. - advanced_options : dict:: - sortkey2 : string - existing_table_rows : string - contact_lists : string - partition_schema_name : string - partition_table_partition_column_max_name : string - mysql_catalog_matches_schema : boolean - sortkey1 : string - distkey : string - partition_table_partition_column_min_name : string - invalid_char_replacement : string - partition_table_name : string - wipe_destination_table : boolean - export_action : string - identity_column : string - truncate_long_lines : boolean - sql_query : string - column_delimiter : string - max_errors : integer - partition_column_name : string - row_chunk_size : integer - soql_query : string - first_row_is_header : boolean - verify_table_row_counts : boolean - last_modified_column : string - source : dict:: - path : string The path of the dataset to sync from; for a database source, schema.tablename. - id : integer The ID of the table or file, if available. - destination : dict:: - path : string The schema.tablename to sync to. - id : integer
destination : dict:
- credential_id : integer - additional_credentials : list Array that holds additional credentials used for specific imports. For salesforce imports, the first and only element is the client credential id. - remote_host_id : integer - name : string
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/date-time
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
sync_type : string
The type of sync to perform; one of Dbsync, AutoImport, SilverpopDataImport, SilverpopContactImport, GdocImport, GdocExport, and Salesforce.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer
Parent id to trigger this import from
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
The name of the import.
-
put_projects(id, project_id)¶ Add a JobTypes::Import to a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Set the permissions groups has on this object
Parameters: id : integer
ID of the resource to be shared
permission_level : string
Options are: “read”, “write”, or “manage”
group_ids : list
An array of one or more group IDs
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
Set the permissions users have on this object
Parameters: id : integer
ID of the resource to be shared
user_ids : list
An array of one or more user IDs
permission_level : string
Options are: “read”, “write”, or “manage”
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
put_syncs(id, sync_id, source, destination, **kwargs)¶ Update a sync
Parameters: id : integer
The ID of the import to fetch.
sync_id : integer
The ID of the sync to fetch.
source : dict:
- path : string The path of the dataset to sync from; for a database source, schema.tablename.
destination : dict:
- path : string The schema.tablename to sync to.
advanced_options : dict, optional:
- sortkey2 : string - existing_table_rows : string - contact_lists : string - partition_schema_name : string - partition_table_partition_column_max_name : string - mysql_catalog_matches_schema : boolean - sortkey1 : string - distkey : string - partition_table_partition_column_min_name : string - invalid_char_replacement : string - partition_table_name : string - wipe_destination_table : boolean - export_action : string - identity_column : string - truncate_long_lines : boolean - sql_query : string - column_delimiter : string - max_errors : integer - partition_column_name : string - row_chunk_size : integer - soql_query : string - first_row_is_header : boolean - verify_table_row_counts : boolean - last_modified_column : string
Returns: advanced_options : dict:
- sortkey2 : string - existing_table_rows : string - contact_lists : string - partition_schema_name : string - partition_table_partition_column_max_name : string - mysql_catalog_matches_schema : boolean - sortkey1 : string - distkey : string - partition_table_partition_column_min_name : string - invalid_char_replacement : string - partition_table_name : string - wipe_destination_table : boolean - export_action : string - identity_column : string - truncate_long_lines : boolean - sql_query : string - column_delimiter : string - max_errors : integer - partition_column_name : string - row_chunk_size : integer - soql_query : string - first_row_is_header : boolean - verify_table_row_counts : boolean - last_modified_column : string
source : dict:
- path : string The path of the dataset to sync from; for a database source, schema.tablename. - id : integer The ID of the table or file, if available.
destination : dict:
- path : string The schema.tablename to sync to.
id : integer
-
Jobs¶
-
class
Jobs(session, return_type='civis')¶ Methods
delete_projects(id, project_id)Remove a Job from a project delete_shares_groups(id, group_id)Revoke the permissions a group has on this object delete_shares_users(id, user_id)Revoke the permissions a user has on this object get(id)Show basic job info get_runs(id, run_id)Check status of a job list(**kwargs)List jobs list_children(id)Show nested tree of children that this job triggers list_parents(id)Show chain of parents as a list that this job triggers from list_projects(id)List the projects a Job belongs to list_shares(id)List users and groups permissioned on this object post_runs(id)Run a job post_trigger_email(id)Generate and retrieve trigger email address put_projects(id, project_id)Add a Job to a project put_shares_groups(id, permission_level, ...)Set the permissions groups has on this object put_shares_users(id, user_ids, permission_level)Set the permissions users have on this object -
delete_projects(id, project_id)¶ Remove a Job from a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Revoke the permissions a group has on this object
Parameters: id : integer
ID of the resource to be revoked
group_id : integer
ID of the group
Returns: None
Response code 204: success
Revoke the permissions a user has on this object
Parameters: id : integer
ID of the resource to be revoked
user_id : integer
ID of the user
Returns: None
Response code 204: success
-
get(id)¶ Show basic job info
Parameters: id : integer
The ID for this job.
Returns: archived : string
The archival status of the requested object(s).
state : string
Whether the job is idle, queued, running, cancelled, or failed.
updated_at : string/date-time
created_at : string/date-time
id : integer
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
type : string
runs : list:
Information about the most recent runs of the job. - state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
-
get_runs(id, run_id)¶ Check status of a job
Parameters: id : integer
The ID of the Job.
run_id : integer
The ID of the Run.
Returns: state : string
created_at : string/time
The time that the run was queued.
id : integer
error : string
The error message for this run, if present.
finished_at : string/time
The time that the run completed.
started_at : string/time
The time that the run started.
-
list(**kwargs)¶ List jobs
Parameters: limit : integer, optional
The maximum number of jobs to return.
state : string, optional
The job’s state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., “A,B”).
type : string, optional
The job’s type. Specify multiple values as a comma-separated list (e.g., “A,B”).
q : string, optional
Query string to search on the id, name, and job type
permission : string, optional
A permissions string, one of “read”, “write”, or “manage”. Lists only jobs for which the current user has that permission.
archived : string, optional
The archival status of the requested object(s).
Returns: state : string
Whether the job is idle, queued, running, cancelled, or failed.
updated_at : string/date-time
created_at : string/date-time
id : integer
type : string
archived : string
The archival status of the requested object(s).
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
-
list_children(id)¶ Show nested tree of children that this job triggers
Parameters: id : integer
The ID for this job.
Returns: state : string
updated_at : string/date-time
created_at : string/date-time
id : integer
type : string
runs : list:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
children : list
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
-
list_parents(id)¶ Show chain of parents as a list that this job triggers from
Parameters: id : integer
The ID for this job.
Returns: archived : string
The archival status of the requested object(s).
state : string
Whether the job is idle, queued, running, cancelled, or failed.
updated_at : string/date-time
created_at : string/date-time
id : integer
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
type : string
runs : list:
Information about the most recent runs of the job. - state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
-
list_projects(id)¶ List the projects a Job belongs to
Parameters: id : integer
The ID of the resource.
Returns: updated_at : string/time
description : string
A description of the project
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
id : integer
The ID for this project.
auto_share : boolean
archived : string
The archival status of the requested object(s).
name : string
The name of this project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
List users and groups permissioned on this object
Parameters: id : integer
The ID of the object.
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
post_runs(id)¶ Run a job
Parameters: id : integer
The ID for this job.
Returns: state : string
created_at : string/time
The time that the run was queued.
id : integer
error : string
The error message for this run, if present.
finished_at : string/time
The time that the run completed.
started_at : string/time
The time that the run started.
-
post_trigger_email(id)¶ Generate and retrieve trigger email address
Parameters: id : integer
The ID for this job.
Returns: trigger_email : string
Email address which may be used to trigger this job to run.
-
put_projects(id, project_id)¶ Add a Job to a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Set the permissions groups has on this object
Parameters: id : integer
ID of the resource to be shared
permission_level : string
Options are: “read”, “write”, or “manage”
group_ids : list
An array of one or more group IDs
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
Set the permissions users have on this object
Parameters: id : integer
ID of the resource to be shared
user_ids : list
An array of one or more user IDs
permission_level : string
Options are: “read”, “write”, or “manage”
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
Models¶
-
class
Models(session, return_type='civis')¶ Methods
delete_builds(id, build_id)Cancel a build delete_projects(id, project_id)Remove a models from a project delete_shares_groups(id, group_id)Revoke the permissions a group has on this object delete_shares_users(id, user_id)Revoke the permissions a user has on this object get(id)Retrieve model configuration get_builds(id, build_id)Check status of a build list(**kwargs)List models list_builds(id, **kwargs)List builds for the given model list_projects(id)List the projects a models belongs to list_schedules(id)Show the model build schedule list_shares(id)List users and groups permissioned on this object list_types()List all available model types patch(id, **kwargs)Update model configuration post(**kwargs)Create new configuration for a model post_builds(id)Start a build put_archive(id, status)Update the archive status of this object put_predictions(id, primary_key, table_name, ...)Add a table on which to apply the predictive model put_projects(id, project_id)Add a models to a project put_schedules(id, schedule)Schedule the model build put_shares_groups(id, permission_level, ...)Set the permissions groups has on this object put_shares_users(id, user_ids, permission_level)Set the permissions users have on this object -
delete_builds(id, build_id)¶ Cancel a build
Parameters: id : integer
The ID of the model.
build_id : integer
The ID of the build.
Returns: None
Response code 202: success
-
delete_projects(id, project_id)¶ Remove a models from a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Revoke the permissions a group has on this object
Parameters: id : integer
ID of the resource to be revoked
group_id : integer
ID of the group
Returns: None
Response code 204: success
Revoke the permissions a user has on this object
Parameters: id : integer
ID of the resource to be revoked
user_id : integer
ID of the user
Returns: None
Response code 204: success
-
get(id)¶ Retrieve model configuration
Parameters: id : integer
The ID of the model.
Returns: interaction_terms : boolean
Whether to search for interaction terms.
limiting_sql : string
A custom SQL WHERE clause used to filter the rows used to build the model. (e.g., “id > 105”).
archived : string
The archival status of the requested object(s).
updated_at : string/date-time
The time the model was updated.
cross_validation_parameters : dict
Cross validation parameter grid for tree methods, e.g. {“n_estimators”: [100, 200, 500], “learning_rate”: [0.01, 0.1], “max_depth”: [2, 3]}.
credential_id : integer
The ID of the credential used to read the target table. Defaults to the user’s default credential.
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
description : string
A description of the model.
dependent_variable_order : list
The order of dependent variables, especially useful for Ordinal Modeling.
dependent_variable : string
The dependent variable of the training dataset.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
time_zone : string
The time zone of this model.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer
The ID of the parent job that will trigger this model.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
predictions : list:
The tables upon which the model will be applied. - limiting_sql : string A SQL WHERE clause used to scope the rows to be predicted. - output_table : string The qualified name of the table to be created which will contain the model's predictions. - state : string The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted. - table_name : string The qualified name of the table on which to apply the predictive model. - id : integer The ID of the model to which to apply the prediction. - schedule : dict:: - scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday - primary_key : list The primary key or composite keys of the table being predicted.
database_id : integer
The ID of the database holding the training set table used to build the model.
builds : list:
A list of trained models available for making predictions. - description : string A description of the model build. - r_squared_error : number/float A key metric for continuous models. Nil for other model types. - created_at : string The time the model build was created. - id : integer The ID of the model build. - root_mean_squared_error : number/float A key metric for continuous models. Nil for other model types. - roc_auc : number/float A key metric for binary, multinomial, and ordinal models. Nil for other model types. - name : string The name of the model build.
box_cox_transformation : boolean
Whether to transform data so that it assumes a normal distribution. Valid only with continuous models.
last_output_location : string
The output JSON for the last build.
table_name : string
The qualified name of the table containing the training set from which to build the model.
id : integer
The ID of the model.
model_type_id : integer
The ID of the model’s type.
current_build_exception : string
Exception message, if applicable, of the current model build.
model_name : string
The name of the model.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
created_at : string/date-time
The time the model was created.
active_build_id : integer
The ID of the current active build, the build used to score predictions.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
excluded_columns : list
A list of columns which will be considered ineligible to be independent variables.
number_of_folds : integer
Number of folds for cross validation. Default value is 5.
primary_key : string
The unique ID (primary key) of the training dataset.
current_build_state : string
The status of the current model build. One of “succeeded”, “failed”, “queued”, or “running,”or “idle”, if no build has been attempted.
-
get_builds(id, build_id)¶ Check status of a build
Parameters: id : integer
The ID of the model.
build_id : integer
The ID of the build.
Returns: r_squared_error : number/float
A key metric for continuous models. Nil for other model types.
state : string
The state of the model build.one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
output_location : string
A URL representing the location of the full JSON output for the specified build.The URL link will be valid for 5 minutes.
id : integer
The ID of the model build.
transformation_metadata : string
A string representing the full JSON output of the metadata for transformation of column names
roc_auc : number/float
A key metric for binary, multinomial, and ordinal models. Nil for other model types.
description : string
A description of the model build.
created_at : string
The time the model build was created.
root_mean_squared_error : number/float
A key metric for continuous models. Nil for other model types.
error : string
The error, if any, returned by the build.
output : string
A string representing the JSON output for the specified build. Only present when smaller than 10KB in size.
name : string
The name of the model build.
-
list(**kwargs)¶ List models
Parameters: model_name : string, optional
If specified, will be used to filter the models returned. Substring matching is supported. (e.g., “modelName=model” will return both “model1” and “my model”).
training_table_name : string, optional
If specified, will be used to filter the models returned by the training dataset table name. Substring matching is supported. (e.g., “trainingTableName=table” will return both “table1” and “my_table”).
dependent_variable : string, optional
If specified, will be used to filter the models returned by the dependent variable column name. Substring matching is supported. (e.g., “dependentVariable=predictor” will return both “predictor” and “my predictor”).
author : string, optional
If specified, return models from this author. It accepts a comma-separated list of author ids.
status : string, optional
If specified, returns models with one of these statuses. It accepts a comma-separated list, possible values are ‘running’, ‘failed’, ‘succeeded’, ‘idle’, ‘scheduled’.
archived : string, optional
The archival status of the requested object(s).
limit : integer, optional
Number of results to return. Defaults to its maximum of 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, model_name, created_at, name, last_run.updated_at.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: interaction_terms : boolean
Whether to search for interaction terms.
limiting_sql : string
A custom SQL WHERE clause used to filter the rows used to build the model. (e.g., “id > 105”).
archived : string
The archival status of the requested object(s).
updated_at : string/date-time
The time the model was updated.
cross_validation_parameters : dict
Cross validation parameter grid for tree methods, e.g. {“n_estimators”: [100, 200, 500], “learning_rate”: [0.01, 0.1], “max_depth”: [2, 3]}.
credential_id : integer
The ID of the credential used to read the target table. Defaults to the user’s default credential.
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
description : string
A description of the model.
dependent_variable_order : list
The order of dependent variables, especially useful for Ordinal Modeling.
dependent_variable : string
The dependent variable of the training dataset.
time_zone : string
The time zone of this model.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer
The ID of the parent job that will trigger this model.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
predictions : list:
The tables upon which the model will be applied. - limiting_sql : string A SQL WHERE clause used to scope the rows to be predicted. - output_table : string The qualified name of the table to be created which will contain the model's predictions. - state : string The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted. - table_name : string The qualified name of the table on which to apply the predictive model. - id : integer The ID of the model to which to apply the prediction. - primary_key : list The primary key or composite keys of the table being predicted.
database_id : integer
The ID of the database holding the training set table used to build the model.
builds : list:
A list of trained models available for making predictions. - description : string A description of the model build. - r_squared_error : number/float A key metric for continuous models. Nil for other model types. - created_at : string The time the model build was created. - id : integer The ID of the model build. - root_mean_squared_error : number/float A key metric for continuous models. Nil for other model types. - roc_auc : number/float A key metric for binary, multinomial, and ordinal models. Nil for other model types. - name : string The name of the model build.
box_cox_transformation : boolean
Whether to transform data so that it assumes a normal distribution. Valid only with continuous models.
last_output_location : string
The output JSON for the last build.
table_name : string
The qualified name of the table containing the training set from which to build the model.
id : integer
The ID of the model.
model_type_id : integer
The ID of the model’s type.
current_build_exception : string
Exception message, if applicable, of the current model build.
model_name : string
The name of the model.
created_at : string/date-time
The time the model was created.
excluded_columns : list
A list of columns which will be considered ineligible to be independent variables.
number_of_folds : integer
Number of folds for cross validation. Default value is 5.
primary_key : string
The unique ID (primary key) of the training dataset.
current_build_state : string
The status of the current model build. One of “succeeded”, “failed”, “queued”, or “running,”or “idle”, if no build has been attempted.
-
list_builds(id, **kwargs)¶ List builds for the given model
Parameters: id : integer
The ID of the model.
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 100.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to id. Must be one of: id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: r_squared_error : number/float
A key metric for continuous models. Nil for other model types.
state : string
The state of the model build.one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
output_location : string
A URL representing the location of the full JSON output for the specified build.The URL link will be valid for 5 minutes.
id : integer
The ID of the model build.
transformation_metadata : string
A string representing the full JSON output of the metadata for transformation of column names
roc_auc : number/float
A key metric for binary, multinomial, and ordinal models. Nil for other model types.
description : string
A description of the model build.
created_at : string
The time the model build was created.
root_mean_squared_error : number/float
A key metric for continuous models. Nil for other model types.
error : string
The error, if any, returned by the build.
output : string
A string representing the JSON output for the specified build. Only present when smaller than 10KB in size.
name : string
The name of the model build.
-
list_projects(id)¶ List the projects a models belongs to
Parameters: id : integer
The ID of the resource.
Returns: updated_at : string/time
description : string
A description of the project
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
id : integer
The ID for this project.
auto_share : boolean
archived : string
The archival status of the requested object(s).
name : string
The name of this project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
-
list_schedules(id)¶ Show the model build schedule
Parameters: id : integer
The ID of the model associated with this schedule.
Returns: schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
id : integer
The ID of the model associated with this schedule.
List users and groups permissioned on this object
Parameters: id : integer
The ID of the object.
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
list_types()¶ List all available model types
Returns: fint_allowed : boolean
Whether this model type supports searching for interaction terms.
algorithm : string
The name of the algorithm used to train the model.
dv_type : string
The type of dependent variable predicted by the model.
id : integer
The ID of the model type.
-
patch(id, **kwargs)¶ Update model configuration
Parameters: id : integer
The ID of the model.
database_id : integer, optional
The ID of the database holding the training set table used to build the model.
interaction_terms : boolean, optional
Whether to search for interaction terms.
box_cox_transformation : boolean, optional
Whether to transform data so that it assumes a normal distribution. Valid only with continuous models.
cross_validation_parameters : dict, optional
Cross validation parameter grid for tree methods, e.g. {“n_estimators”: [100, 200, 500], “learning_rate”: [0.01, 0.1], “max_depth”: [2, 3]}.
table_name : string, optional
The qualified name of the table containing the training set from which to build the model.
model_type_id : integer, optional
The ID of the model’s type.
credential_id : integer, optional
The ID of the credential used to read the target table. Defaults to the user’s default credential.
limiting_sql : string, optional
A custom SQL WHERE clause used to filter the rows used to build the model. (e.g., “id > 105”).
model_name : string, optional
The name of the model.
description : string, optional
A description of the model.
dependent_variable_order : list, optional
The order of dependent variables, especially useful for Ordinal Modeling.
dependent_variable : string, optional
The dependent variable of the training dataset.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
active_build_id : integer, optional
The ID of the current active build, the build used to score predictions.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
excluded_columns : list, optional
A list of columns which will be considered ineligible to be independent variables.
parent_id : integer, optional
The ID of the parent job that will trigger this model.
number_of_folds : integer, optional
Number of folds for cross validation. Default value is 5.
primary_key : string, optional
The unique ID (primary key) of the training dataset.
time_zone : string, optional
The time zone of this model.
Returns: None
Response code 204: success
-
post(**kwargs)¶ Create new configuration for a model
Parameters: database_id : integer, optional
The ID of the database holding the training set table used to build the model.
interaction_terms : boolean, optional
Whether to search for interaction terms.
box_cox_transformation : boolean, optional
Whether to transform data so that it assumes a normal distribution. Valid only with continuous models.
cross_validation_parameters : dict, optional
Cross validation parameter grid for tree methods, e.g. {“n_estimators”: [100, 200, 500], “learning_rate”: [0.01, 0.1], “max_depth”: [2, 3]}.
table_name : string, optional
The qualified name of the table containing the training set from which to build the model.
model_type_id : integer, optional
The ID of the model’s type.
credential_id : integer, optional
The ID of the credential used to read the target table. Defaults to the user’s default credential.
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
limiting_sql : string, optional
A custom SQL WHERE clause used to filter the rows used to build the model. (e.g., “id > 105”).
model_name : string, optional
The name of the model.
description : string, optional
A description of the model.
dependent_variable_order : list, optional
The order of dependent variables, especially useful for Ordinal Modeling.
dependent_variable : string, optional
The dependent variable of the training dataset.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
active_build_id : integer, optional
The ID of the current active build, the build used to score predictions.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
excluded_columns : list, optional
A list of columns which will be considered ineligible to be independent variables.
parent_id : integer, optional
The ID of the parent job that will trigger this model.
number_of_folds : integer, optional
Number of folds for cross validation. Default value is 5.
primary_key : string, optional
The unique ID (primary key) of the training dataset.
time_zone : string, optional
The time zone of this model.
Returns: interaction_terms : boolean
Whether to search for interaction terms.
limiting_sql : string
A custom SQL WHERE clause used to filter the rows used to build the model. (e.g., “id > 105”).
archived : string
The archival status of the requested object(s).
updated_at : string/date-time
The time the model was updated.
cross_validation_parameters : dict
Cross validation parameter grid for tree methods, e.g. {“n_estimators”: [100, 200, 500], “learning_rate”: [0.01, 0.1], “max_depth”: [2, 3]}.
credential_id : integer
The ID of the credential used to read the target table. Defaults to the user’s default credential.
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
description : string
A description of the model.
dependent_variable_order : list
The order of dependent variables, especially useful for Ordinal Modeling.
dependent_variable : string
The dependent variable of the training dataset.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
time_zone : string
The time zone of this model.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer
The ID of the parent job that will trigger this model.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
predictions : list:
The tables upon which the model will be applied. - limiting_sql : string A SQL WHERE clause used to scope the rows to be predicted. - output_table : string The qualified name of the table to be created which will contain the model's predictions. - state : string The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted. - table_name : string The qualified name of the table on which to apply the predictive model. - id : integer The ID of the model to which to apply the prediction. - schedule : dict:: - scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday - primary_key : list The primary key or composite keys of the table being predicted.
database_id : integer
The ID of the database holding the training set table used to build the model.
builds : list:
A list of trained models available for making predictions. - description : string A description of the model build. - r_squared_error : number/float A key metric for continuous models. Nil for other model types. - created_at : string The time the model build was created. - id : integer The ID of the model build. - root_mean_squared_error : number/float A key metric for continuous models. Nil for other model types. - roc_auc : number/float A key metric for binary, multinomial, and ordinal models. Nil for other model types. - name : string The name of the model build.
box_cox_transformation : boolean
Whether to transform data so that it assumes a normal distribution. Valid only with continuous models.
last_output_location : string
The output JSON for the last build.
table_name : string
The qualified name of the table containing the training set from which to build the model.
id : integer
The ID of the model.
model_type_id : integer
The ID of the model’s type.
current_build_exception : string
Exception message, if applicable, of the current model build.
model_name : string
The name of the model.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
created_at : string/date-time
The time the model was created.
active_build_id : integer
The ID of the current active build, the build used to score predictions.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
excluded_columns : list
A list of columns which will be considered ineligible to be independent variables.
number_of_folds : integer
Number of folds for cross validation. Default value is 5.
primary_key : string
The unique ID (primary key) of the training dataset.
current_build_state : string
The status of the current model build. One of “succeeded”, “failed”, “queued”, or “running,”or “idle”, if no build has been attempted.
-
post_builds(id)¶ Start a build
Parameters: id : integer
The ID of the model.
Returns: r_squared_error : number/float
A key metric for continuous models. Nil for other model types.
state : string
The state of the model build.one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
output_location : string
A URL representing the location of the full JSON output for the specified build.The URL link will be valid for 5 minutes.
id : integer
The ID of the model build.
transformation_metadata : string
A string representing the full JSON output of the metadata for transformation of column names
roc_auc : number/float
A key metric for binary, multinomial, and ordinal models. Nil for other model types.
description : string
A description of the model build.
created_at : string
The time the model build was created.
root_mean_squared_error : number/float
A key metric for continuous models. Nil for other model types.
error : string
The error, if any, returned by the build.
output : string
A string representing the JSON output for the specified build. Only present when smaller than 10KB in size.
name : string
The name of the model build.
-
put_archive(id, status)¶ Update the archive status of this object
Parameters: id : integer
The ID of the object.
status : boolean
The desired archived status of the object.
Returns: interaction_terms : boolean
Whether to search for interaction terms.
limiting_sql : string
A custom SQL WHERE clause used to filter the rows used to build the model. (e.g., “id > 105”).
archived : string
The archival status of the requested object(s).
updated_at : string/date-time
The time the model was updated.
cross_validation_parameters : dict
Cross validation parameter grid for tree methods, e.g. {“n_estimators”: [100, 200, 500], “learning_rate”: [0.01, 0.1], “max_depth”: [2, 3]}.
credential_id : integer
The ID of the credential used to read the target table. Defaults to the user’s default credential.
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
description : string
A description of the model.
dependent_variable_order : list
The order of dependent variables, especially useful for Ordinal Modeling.
dependent_variable : string
The dependent variable of the training dataset.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
time_zone : string
The time zone of this model.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer
The ID of the parent job that will trigger this model.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
predictions : list:
The tables upon which the model will be applied. - limiting_sql : string A SQL WHERE clause used to scope the rows to be predicted. - output_table : string The qualified name of the table to be created which will contain the model's predictions. - state : string The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted. - table_name : string The qualified name of the table on which to apply the predictive model. - id : integer The ID of the model to which to apply the prediction. - schedule : dict:: - scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday - primary_key : list The primary key or composite keys of the table being predicted.
database_id : integer
The ID of the database holding the training set table used to build the model.
builds : list:
A list of trained models available for making predictions. - description : string A description of the model build. - r_squared_error : number/float A key metric for continuous models. Nil for other model types. - created_at : string The time the model build was created. - id : integer The ID of the model build. - root_mean_squared_error : number/float A key metric for continuous models. Nil for other model types. - roc_auc : number/float A key metric for binary, multinomial, and ordinal models. Nil for other model types. - name : string The name of the model build.
box_cox_transformation : boolean
Whether to transform data so that it assumes a normal distribution. Valid only with continuous models.
last_output_location : string
The output JSON for the last build.
table_name : string
The qualified name of the table containing the training set from which to build the model.
id : integer
The ID of the model.
model_type_id : integer
The ID of the model’s type.
current_build_exception : string
Exception message, if applicable, of the current model build.
model_name : string
The name of the model.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
created_at : string/date-time
The time the model was created.
active_build_id : integer
The ID of the current active build, the build used to score predictions.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
excluded_columns : list
A list of columns which will be considered ineligible to be independent variables.
number_of_folds : integer
Number of folds for cross validation. Default value is 5.
primary_key : string
The unique ID (primary key) of the training dataset.
current_build_state : string
The status of the current model build. One of “succeeded”, “failed”, “queued”, or “running,”or “idle”, if no build has been attempted.
-
put_predictions(id, primary_key, table_name, **kwargs)¶ Add a table on which to apply the predictive model
Parameters: id : integer
The ID of the model to which to apply the prediction.
primary_key : list
The primary key or composite keys of the table being predicted.
table_name : string
The qualified name of the table on which to apply the predictive model.
limiting_sql : string, optional
A SQL WHERE clause used to scope the rows to be predicted.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
output_table : string, optional
The qualified name of the table to be created which will contain the model’s predictions.
Returns: limiting_sql : string
A SQL WHERE clause used to scope the rows to be predicted.
output_table : string
The qualified name of the table to be created which will contain the model’s predictions.
state : string
The status of the prediction. One of: “succeeded”, “failed”, “queued”, or “running,”or “idle”, if no build has been attempted.
table_name : string
The qualified name of the table on which to apply the predictive model.
id : integer
The ID of the model to which to apply the prediction.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
primary_key : list
The primary key or composite keys of the table being predicted.
-
put_projects(id, project_id)¶ Add a models to a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
-
put_schedules(id, schedule)¶ Schedule the model build
Parameters: id : integer
The ID of the model associated with this schedule.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
Returns: schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
id : integer
The ID of the model associated with this schedule.
Set the permissions groups has on this object
Parameters: id : integer
ID of the resource to be shared
permission_level : string
Options are: “read”, “write”, or “manage”
group_ids : list
An array of one or more group IDs
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
Set the permissions users have on this object
Parameters: id : integer
ID of the resource to be shared
user_ids : list
An array of one or more user IDs
permission_level : string
Options are: “read”, “write”, or “manage”
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
Predictions¶
-
class
Predictions(session, return_type='civis')¶ Methods
delete_runs(id, run_id)Cancel a run get(id)Show the specified prediction get_runs(id, run_id)Check status of a run list(**kwargs)List predictions list_runs(id, **kwargs)List runs for the given prediction list_schedules(id)Show the prediction schedule patch(id, **kwargs)Update a prediction post_runs(id)Start a run put_schedules(id, **kwargs)Schedule the prediction -
delete_runs(id, run_id)¶ Cancel a run
Parameters: id : integer
The ID of the prediction.
run_id : integer
The ID of the run.
Returns: None
Response code 202: success
-
get(id)¶ Show the specified prediction
Parameters: id : integer
The ID of the prediction.
Returns: limiting_sql : string
A SQL WHERE clause used to scope the rows to be predicted.
scored_tables : list:
An array of created prediction tables. - score_stats : list:: An array of metrics on the created predictions. - min_score : number/float The minimum score. - histogram : list The histogram of the distribution of scores. - max_score : number/float The maximum score. - avg_score : number/float The average score. - score_name : string The name of the score. - schema : string The schema of table with created predictions. - created_at : string/date-time The time when the table with created predictions was created. - name : string The name of table with created predictions. - id : integer The ID of the table with created predictions.
state : string
The state of the last run of this prediction.
scored_table_id : integer
The ID of the source table for this prediction.
id : integer
The ID of the prediction.
primary_key : list
The primary key or composite keys of the table being predicted.
finished_at : string/date-time
The end time of the last run of this prediction.
started_at : string/date-time
The start time of the last run of this prediction.
model_id : integer
The ID of the model used for this prediction.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
output_table_name : string
The name of the output table for this prediction.
scored_table_name : string
The name of the source table for this prediction.
error : string
The error, if any, of the last run of this prediction.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
-
get_runs(id, run_id)¶ Check status of a run
Parameters: id : integer
The ID of the prediction.
run_id : integer
The ID of the run.
Returns: state : string
The state of the prediction run.
created_at : string/date-time
The time when the table with created predictions was created.
id : integer
The ID of the prediction run.
score_stats : list:
An array of metrics on the created predictions. - min_score : number/float The minimum score. - histogram : list The histogram of the distribution of scores. - max_score : number/float The maximum score. - avg_score : number/float The average score. - score_name : string The name of the score.
prediction_id : integer
The ID of the prediction.
name : string
The name of table created by this predictions run.
exception : string
The exception, if any, returned by the prediction run.
-
list(**kwargs)¶ List predictions
Parameters: model_id : integer, optional
If specified, only return predictions associated with this model ID.
Returns: last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
state : string
The state of the last run of this prediction.
finished_at : string/date-time
The end time of the last run of this prediction.
scored_table_id : integer
The ID of the source table for this prediction.
output_table_name : string
The name of the output table for this prediction.
scored_table_name : string
The name of the source table for this prediction.
error : string
The error, if any, of the last run of this prediction.
id : integer
The ID of the prediction.
model_id : integer
The ID of the model used for this prediction.
started_at : string/date-time
The start time of the last run of this prediction.
-
list_runs(id, **kwargs)¶ List runs for the given prediction
Parameters: id : integer
The ID of the prediction.
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 100.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to id. Must be one of: id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: state : string
The state of the prediction run.
created_at : string/date-time
The time when the table with created predictions was created.
id : integer
The ID of the prediction run.
score_stats : list:
An array of metrics on the created predictions. - min_score : number/float The minimum score. - histogram : list The histogram of the distribution of scores. - max_score : number/float The maximum score. - avg_score : number/float The average score. - score_name : string The name of the score.
prediction_id : integer
The ID of the prediction.
name : string
The name of table created by this predictions run.
exception : string
The exception, if any, returned by the prediction run.
-
list_schedules(id)¶ Show the prediction schedule
Parameters: id : integer
ID of the prediction associated with this schedule.
Returns: schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
score_on_model_build : boolean
Whether the prediction will run after a rebuild of the associated model.
id : integer
ID of the prediction associated with this schedule.
-
patch(id, **kwargs)¶ Update a prediction
Parameters: id : integer
The ID of the prediction.
limiting_sql : string, optional
A SQL WHERE clause used to scope the rows to be predicted.
primary_key : list, optional
The primary key or composite keys of the table being predicted.
output_table_name : string, optional
The name of the output table for this prediction.
Returns: limiting_sql : string
A SQL WHERE clause used to scope the rows to be predicted.
scored_tables : list:
An array of created prediction tables. - score_stats : list:: An array of metrics on the created predictions. - min_score : number/float The minimum score. - histogram : list The histogram of the distribution of scores. - max_score : number/float The maximum score. - avg_score : number/float The average score. - score_name : string The name of the score. - schema : string The schema of table with created predictions. - created_at : string/date-time The time when the table with created predictions was created. - name : string The name of table with created predictions. - id : integer The ID of the table with created predictions.
state : string
The state of the last run of this prediction.
scored_table_id : integer
The ID of the source table for this prediction.
id : integer
The ID of the prediction.
primary_key : list
The primary key or composite keys of the table being predicted.
finished_at : string/date-time
The end time of the last run of this prediction.
started_at : string/date-time
The start time of the last run of this prediction.
model_id : integer
The ID of the model used for this prediction.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
output_table_name : string
The name of the output table for this prediction.
scored_table_name : string
The name of the source table for this prediction.
error : string
The error, if any, of the last run of this prediction.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
-
post_runs(id)¶ Start a run
Parameters: id : integer
The ID of the prediction.
Returns: state : string
The state of the prediction run.
created_at : string/date-time
The time when the table with created predictions was created.
id : integer
The ID of the prediction run.
score_stats : list:
An array of metrics on the created predictions. - min_score : number/float The minimum score. - histogram : list The histogram of the distribution of scores. - max_score : number/float The maximum score. - avg_score : number/float The average score. - score_name : string The name of the score.
prediction_id : integer
The ID of the prediction.
name : string
The name of table created by this predictions run.
exception : string
The exception, if any, returned by the prediction run.
-
put_schedules(id, **kwargs)¶ Schedule the prediction
Parameters: id : integer
ID of the prediction associated with this schedule.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
score_on_model_build : boolean, optional
Whether the prediction will run after a rebuild of the associated model.
Returns: schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
score_on_model_build : boolean
Whether the prediction will run after a rebuild of the associated model.
id : integer
ID of the prediction associated with this schedule.
-
Projects¶
-
class
Projects(session, return_type='civis')¶ Methods
delete_shares_groups(id, group_id)Revoke the permissions a group has on this object delete_shares_users(id, user_id)Revoke the permissions a user has on this object get(project_id)Get a detailed view of a project and the objects in it list(**kwargs)List projects list_shares(id)List users and groups permissioned on this object post(description, name, **kwargs)Create a project put(project_id, **kwargs)Update a project put_archive(id, status)Update the archive status of this object put_shares_groups(id, permission_level, ...)Set the permissions groups has on this object put_shares_users(id, user_ids, permission_level)Set the permissions users have on this object Revoke the permissions a group has on this object
Parameters: id : integer
ID of the resource to be revoked
group_id : integer
ID of the group
Returns: None
Response code 204: success
Revoke the permissions a user has on this object
Parameters: id : integer
ID of the resource to be revoked
user_id : integer
ID of the user
Returns: None
Response code 204: success
-
get(project_id)¶ Get a detailed view of a project and the objects in it
Parameters: project_id : integer
Returns: all_objects : list:
- fco_type : string - icon : string - object_type : string - project_id : integer - author : string - sub_type : string - object_id : integer - archived : string The archival status of the requested object(s). - name : string
archived : string
The archival status of the requested object(s).
updated_at : string/time
imports : list:
- state : string - updated_at : string/time - created_at : string/time - id : integer The object ID. - type : string - finished_at : string/time - name : string
id : integer
The ID for this project.
auto_share : boolean
files : list:
- file_name : string - file_size : integer - updated_at : string/time - created_at : string/time - id : integer The object ID.
script_templates : list:
- name : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
reports : list:
- state : string - name : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
app_instances : list:
- name : string - slug : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
description : string
A description of the project
scripts : list:
- state : string - updated_at : string/time - created_at : string/time - id : integer The object ID. - type : string - finished_at : string/time - name : string
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
models : list:
- state : string - name : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
tables : list:
- row_count : integer - schema : string - updated_at : string/time - created_at : string/time - column_count : integer - name : string
surveys : list:
- updated_at : string/time - created_at : string/time - id : integer The object ID.
note : string
name : string
The name of this project.
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
-
list(**kwargs)¶ List projects
Parameters: author : string, optional
If specified, return projects owned by this author. It accepts a comma- separated list of author ids.
permission : string, optional
A permissions string, one of “read”, “write”, or “manage”. Lists only projects for which the current user has that permission.
archived : string, optional
The archival status of the requested object(s).
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 1000.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: updated_at : string/time
description : string
A description of the project
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
id : integer
The ID for this project.
auto_share : boolean
archived : string
The archival status of the requested object(s).
name : string
The name of this project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
List users and groups permissioned on this object
Parameters: id : integer
The ID of the object.
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
post(description, name, **kwargs)¶ Create a project
Parameters: description : string
A description of the project
name : string
The name of this project.
note : string, optional
Notes for the project
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
Returns: all_objects : list:
- fco_type : string - icon : string - object_type : string - project_id : integer - author : string - sub_type : string - object_id : integer - archived : string The archival status of the requested object(s). - name : string
archived : string
The archival status of the requested object(s).
updated_at : string/time
imports : list:
- state : string - updated_at : string/time - created_at : string/time - id : integer The object ID. - type : string - finished_at : string/time - name : string
id : integer
The ID for this project.
auto_share : boolean
files : list:
- file_name : string - file_size : integer - updated_at : string/time - created_at : string/time - id : integer The object ID.
script_templates : list:
- name : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
reports : list:
- state : string - name : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
app_instances : list:
- name : string - slug : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
description : string
A description of the project
scripts : list:
- state : string - updated_at : string/time - created_at : string/time - id : integer The object ID. - type : string - finished_at : string/time - name : string
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
models : list:
- state : string - name : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
tables : list:
- row_count : integer - schema : string - updated_at : string/time - created_at : string/time - column_count : integer - name : string
surveys : list:
- updated_at : string/time - created_at : string/time - id : integer The object ID.
note : string
name : string
The name of this project.
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
-
put(project_id, **kwargs)¶ Update a project
Parameters: project_id : integer
description : string, optional
A description of the project
note : string, optional
Notes for the project
name : string, optional
The name of this project.
Returns: all_objects : list:
- fco_type : string - icon : string - object_type : string - project_id : integer - author : string - sub_type : string - object_id : integer - archived : string The archival status of the requested object(s). - name : string
archived : string
The archival status of the requested object(s).
updated_at : string/time
imports : list:
- state : string - updated_at : string/time - created_at : string/time - id : integer The object ID. - type : string - finished_at : string/time - name : string
id : integer
The ID for this project.
auto_share : boolean
files : list:
- file_name : string - file_size : integer - updated_at : string/time - created_at : string/time - id : integer The object ID.
script_templates : list:
- name : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
reports : list:
- state : string - name : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
app_instances : list:
- name : string - slug : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
description : string
A description of the project
scripts : list:
- state : string - updated_at : string/time - created_at : string/time - id : integer The object ID. - type : string - finished_at : string/time - name : string
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
models : list:
- state : string - name : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
tables : list:
- row_count : integer - schema : string - updated_at : string/time - created_at : string/time - column_count : integer - name : string
surveys : list:
- updated_at : string/time - created_at : string/time - id : integer The object ID.
note : string
name : string
The name of this project.
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
-
put_archive(id, status)¶ Update the archive status of this object
Parameters: id : integer
The ID of the object.
status : boolean
The desired archived status of the object.
Returns: all_objects : list:
- fco_type : string - icon : string - object_type : string - project_id : integer - author : string - sub_type : string - object_id : integer - archived : string The archival status of the requested object(s). - name : string
archived : string
The archival status of the requested object(s).
updated_at : string/time
imports : list:
- state : string - updated_at : string/time - created_at : string/time - id : integer The object ID. - type : string - finished_at : string/time - name : string
id : integer
The ID for this project.
auto_share : boolean
files : list:
- file_name : string - file_size : integer - updated_at : string/time - created_at : string/time - id : integer The object ID.
script_templates : list:
- name : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
reports : list:
- state : string - name : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
app_instances : list:
- name : string - slug : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
description : string
A description of the project
scripts : list:
- state : string - updated_at : string/time - created_at : string/time - id : integer The object ID. - type : string - finished_at : string/time - name : string
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
models : list:
- state : string - name : string - updated_at : string/time - created_at : string/time - id : integer The object ID.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
tables : list:
- row_count : integer - schema : string - updated_at : string/time - created_at : string/time - column_count : integer - name : string
surveys : list:
- updated_at : string/time - created_at : string/time - id : integer The object ID.
note : string
name : string
The name of this project.
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
Set the permissions groups has on this object
Parameters: id : integer
ID of the resource to be shared
permission_level : string
Options are: “read”, “write”, or “manage”
group_ids : list
An array of one or more group IDs
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
Set the permissions users have on this object
Parameters: id : integer
ID of the resource to be shared
user_ids : list
An array of one or more user IDs
permission_level : string
Options are: “read”, “write”, or “manage”
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
Queries¶
-
class
Queries(session, return_type='civis')¶ Methods
delete_runs(id, run_id)Cancel a run get(id)Get details about a query get_runs(id, run_id)Check status of a run list(**kwargs)List all queries list_runs(id, **kwargs)List runs for the given query post(sql, preview_rows, database, **kwargs)Execute a query post_runs(id)Start a run put_scripts(id, script_id)Update the query’s associated script -
delete_runs(id, run_id)¶ Cancel a run
Parameters: id : integer
The ID of the query.
run_id : integer
The ID of the run.
Returns: None
Response code 202: success
-
get(id)¶ Get details about a query
Parameters: id : integer
The query ID.
Returns: credential : integer
The credential ID.
database : integer
The database ID.
sql : string
The SQL to execute.
state : string
The state of the last run.
updated_at : string/time
result_columns : list
A preview of columns returned by the query.
result_rows : list
A preview of rows returned by the query.
finished_at : string/date-time
The end time of the last run.
started_at : string/date-time
The start time of the last run.
report_id : integer
The ID of the report associated with this query.
script_id : integer
The ID of the script associated with this query.
last_run_id : integer
The ID of the last run.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
id : integer
The query ID.
name : string
The name of the query.
exception : string
Exception returned from the query, null if the query was a success.
-
get_runs(id, run_id)¶ Check status of a run
Parameters: id : integer
The ID of the query.
run_id : integer
The ID of the run.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
error : string
The error, if any, returned by the run.
id : integer
The ID of the run.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
query_id : integer
The ID of the query.
started_at : string/time
The time the last run started at.
-
list(**kwargs)¶ List all queries
Parameters: database_id : integer, optional
The database ID.
author_id : integer, optional
The author of the query.
created_before : string, optional
An upper bound for the creation date of the query.
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to created_at. Must be one of: created_at.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: credential : integer
The credential ID.
database : integer
The database ID.
sql : string
The SQL to execute.
state : string
The state of the last run.
updated_at : string/time
result_columns : list
A preview of columns returned by the query.
result_rows : list
A preview of rows returned by the query.
finished_at : string/date-time
The end time of the last run.
started_at : string/date-time
The start time of the last run.
report_id : integer
The ID of the report associated with this query.
script_id : integer
The ID of the script associated with this query.
last_run_id : integer
The ID of the last run.
created_at : string/time
preview_rows : integer
The number of rows to save from the query’s result (maximum: 100).
id : integer
The query ID.
exception : string
Exception returned from the query, null if the query was a success.
-
list_runs(id, **kwargs)¶ List runs for the given query
Parameters: id : integer
The ID of the query.
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 100.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to id. Must be one of: id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
error : string
The error, if any, returned by the run.
id : integer
The ID of the run.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
query_id : integer
The ID of the query.
started_at : string/time
The time the last run started at.
-
post(sql, preview_rows, database, **kwargs)¶ Execute a query
Parameters: sql : string
The SQL to execute.
preview_rows : integer
The number of rows to save from the query’s result (maximum: 100).
database : integer
The database ID.
credential : integer, optional
The credential ID.
include_header : boolean, optional
Whether the CSV output should include a header row [default: true].
unquoted : boolean, optional
If true, will not quote fields.
column_delimiter : string, optional
The delimiter to use. One of comma or tab, or pipe [default: comma].
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
compression : string, optional
The type of compression. One of gzip or zip, or none [default: gzip].
filename_prefix : string, optional
The output filename prefix.
interactive : boolean, optional
Deprecated and not used.
Returns: state : string
The state of the last run.
updated_at : string/time
last_run_id : integer
The ID of the last run.
compression : string
The type of compression. One of gzip or zip, or none [default: gzip].
interactive : boolean
Deprecated and not used.
started_at : string/date-time
The start time of the last run.
unquoted : boolean
If true, will not quote fields.
id : integer
The query ID.
preview_rows : integer
The number of rows to save from the query’s result (maximum: 100).
credential : integer
The credential ID.
include_header : boolean
Whether the CSV output should include a header row [default: true].
sql : string
The SQL to execute.
result_columns : list
A preview of columns returned by the query.
database : integer
The database ID.
result_rows : list
A preview of rows returned by the query.
column_delimiter : string
The delimiter to use. One of comma or tab, or pipe [default: comma].
finished_at : string/date-time
The end time of the last run.
exception : string
Exception returned from the query, null if the query was a success.
report_id : integer
The ID of the report associated with this query.
script_id : integer
The ID of the script associated with this query.
created_at : string/time
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
filename_prefix : string
The output filename prefix.
-
post_runs(id)¶ Start a run
Parameters: id : integer
The ID of the query.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
error : string
The error, if any, returned by the run.
id : integer
The ID of the run.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
query_id : integer
The ID of the query.
started_at : string/time
The time the last run started at.
-
put_scripts(id, script_id)¶ Update the query’s associated script
Parameters: id : integer
The query ID.
script_id : integer
The ID of the script associated with this query.
Returns: credential : integer
The credential ID.
database : integer
The database ID.
sql : string
The SQL to execute.
state : string
The state of the last run.
updated_at : string/time
result_columns : list
A preview of columns returned by the query.
result_rows : list
A preview of rows returned by the query.
finished_at : string/date-time
The end time of the last run.
started_at : string/date-time
The start time of the last run.
report_id : integer
The ID of the report associated with this query.
script_id : integer
The ID of the script associated with this query.
last_run_id : integer
The ID of the last run.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
id : integer
The query ID.
name : string
The name of the query.
exception : string
Exception returned from the query, null if the query was a success.
-
Reports¶
-
class
Reports(session, return_type='civis')¶ Methods
delete_grants(id)Revoke permisstion for this report to perform Civis platform API operations on delete_projects(id, project_id)Remove a Report from a project delete_shares_groups(id, group_id)Revoke the permissions a group has on this object delete_shares_users(id, user_id)Revoke the permissions a user has on this object get(id)Show a single report list(**kwargs)List the reports visible to the current user list_projects(id)List the projects a Report belongs to list_shares(id)List users and groups permissioned on this object list_snapshots(id)Get details about the report’s snapshot automation settings patch(id, **kwargs)Update a report patch_snapshots(id, **kwargs)Update the report’s snapshot automation settings post(**kwargs)Create a report post_grants(id)Grant this report the ability to perform Civis platform API operations on your post_snapshots(id, **kwargs)Generate and optionally email a snapshot of the specified report put_archive(id, status)Update the archive status of this object put_projects(id, project_id)Add a Report to a project put_shares_groups(id, permission_level, ...)Set the permissions groups has on this object put_shares_users(id, user_ids, permission_level)Set the permissions users have on this object -
delete_grants(id)¶ Revoke permisstion for this report to perform Civis platform API operations on your behalf
Parameters: id : integer
The ID of this report.
Returns: None
Response code 204: success
-
delete_projects(id, project_id)¶ Remove a Report from a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Revoke the permissions a group has on this object
Parameters: id : integer
ID of the resource to be revoked
group_id : integer
ID of the group
Returns: None
Response code 204: success
Revoke the permissions a user has on this object
Parameters: id : integer
ID of the resource to be revoked
user_id : integer
ID of the user
Returns: None
Response code 204: success
-
get(id)¶ Show a single report
Parameters: id : integer
The ID of this report.
Returns: provide_api_key : boolean
Whether the report requests an API Key from the report viewer.
config : string
Any configuration metadata for this report.
state : string
The status of the report’s last run.
script : dict:
- sql : string The raw SQL query for the script. - name : string The name of the script. - id : integer The ID for the script.
updated_at : string/time
valid_output_file : boolean
Whether the job (a script or a query) that backs the report currently has a valid output file.
tableau_id : integer
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
job_path : string
The link to details of the job that backs this report.
auth_thumbnail_url : string
URL for a thumbnail of the report.
template_id : integer
The ID of the template used for this report.
auth_code_url : string
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
id : integer
The ID of this report.
api_key_id : integer
The ID of the API key. Can be used for auditing API use by this report.
finished_at : string/time
The time that the report’s last run finished.
auth_data_url : string
api_key : string
A Civis API key that can be used by this report.
projects : list:
A list of projects containing the report. - name : string The name of the project. - id : integer The ID for the project.
archived : string
The archival status of the requested object(s).
created_at : string/time
app_state : dict
Any application state blob for this report.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
name : string
The name of the report.
viz_updated_at : string/time
The time that the report’s visualization was last updated.
-
list(**kwargs)¶ List the reports visible to the current user
Parameters: type : string, optional
If specified, return report of these types. It accepts a comma-separated list, possible values are ‘tableau’, ‘other’.
author : string, optional
If specified, return reports from this author. It accepts a comma-separated list of author ids.
template_id : integer, optional
If specified, return reports using the provided Template.
archived : string, optional
The archival status of the requested object(s).
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: state : string
The status of the report’s last run.
script : dict:
- sql : string The raw SQL query for the script. - name : string The name of the script. - id : integer The ID for the script.
updated_at : string/time
tableau_id : integer
id : integer
The ID of this report.
finished_at : string/time
The time that the report’s last run finished.
auth_thumbnail_url : string
URL for a thumbnail of the report.
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
projects : list:
A list of projects containing the report. - name : string The name of the project. - id : integer The ID for the project.
archived : string
The archival status of the requested object(s).
created_at : string/time
template_id : integer
The ID of the template used for this report.
job_path : string
The link to details of the job that backs this report.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
The name of the report.
viz_updated_at : string/time
The time that the report’s visualization was last updated.
-
list_projects(id)¶ List the projects a Report belongs to
Parameters: id : integer
The ID of the resource.
Returns: updated_at : string/time
description : string
A description of the project
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
id : integer
The ID for this project.
auto_share : boolean
archived : string
The archival status of the requested object(s).
name : string
The name of this project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
List users and groups permissioned on this object
Parameters: id : integer
The ID of the object.
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
list_snapshots(id)¶ Get details about the report’s snapshot automation settings
Parameters: id : integer
The ID of this report.
Returns: schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
send_email_on_completion : boolean
Whether the job will send emails on completion.
email_subject : string
Subject for Email.
state : string
The status of the job’s last run.
email_template : string
Custom email template.
width : integer
The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.
id : integer
The ID of this report.
recipient_email_addresses : string
Email addresses to send report to, comma separated.
height : integer
The height of the cropped snapshot image in screen pixels. The default value is 900 pixels. Minimum value is 600 pixels.
finished_at : string/time
The time that the job’s last run finished.
parent_id : integer
The ID of the parent job that will trigger this snapshot.
-
patch(id, **kwargs)¶ Update a report
Parameters: id : integer
The ID of the report to modify.
provide_api_key : boolean, optional
Allow the report to provide an API key to front-end code.
script_id : integer, optional
The ID of the job (a script or a query) used to create this report.
app_state : dict, optional
The application state blob for this report.
config : string, optional
template_id : integer, optional
The ID of the template used for this report. If null is passed, no template will back this report. Changes to the backing template will reset the report appState.
code_body : string, optional
The code for the report visualization.
name : string, optional
The name of the report.
Returns: provide_api_key : boolean
Whether the report requests an API Key from the report viewer.
config : string
Any configuration metadata for this report.
state : string
The status of the report’s last run.
script : dict:
- sql : string The raw SQL query for the script. - name : string The name of the script. - id : integer The ID for the script.
updated_at : string/time
valid_output_file : boolean
Whether the job (a script or a query) that backs the report currently has a valid output file.
tableau_id : integer
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
job_path : string
The link to details of the job that backs this report.
auth_thumbnail_url : string
URL for a thumbnail of the report.
template_id : integer
The ID of the template used for this report.
auth_code_url : string
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
id : integer
The ID of this report.
api_key_id : integer
The ID of the API key. Can be used for auditing API use by this report.
finished_at : string/time
The time that the report’s last run finished.
auth_data_url : string
api_key : string
A Civis API key that can be used by this report.
projects : list:
A list of projects containing the report. - name : string The name of the project. - id : integer The ID for the project.
archived : string
The archival status of the requested object(s).
created_at : string/time
app_state : dict
Any application state blob for this report.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
name : string
The name of the report.
viz_updated_at : string/time
The time that the report’s visualization was last updated.
-
patch_snapshots(id, **kwargs)¶ Update the report’s snapshot automation settings
Parameters: id : integer
The ID of this report.
parent_id : integer, optional
The ID of the parent job that will trigger this snapshot.
send_email_on_completion : boolean, optional
Whether the job will send emails on completion.
email_subject : string, optional
Subject for Email.
state : string, optional
The status of the job’s last run.
recipient_email_addresses : string, optional
Email addresses to send report to, comma separated.
width : integer, optional
The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
email_template : string, optional
Custom email template.
height : integer, optional
The height of the cropped snapshot image in screen pixels. The default value is 900 pixels. Minimum value is 600 pixels.
finished_at : string/time, optional
The time that the job’s last run finished.
Returns: schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
send_email_on_completion : boolean
Whether the job will send emails on completion.
email_subject : string
Subject for Email.
state : string
The status of the job’s last run.
email_template : string
Custom email template.
width : integer
The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.
id : integer
The ID of this report.
recipient_email_addresses : string
Email addresses to send report to, comma separated.
height : integer
The height of the cropped snapshot image in screen pixels. The default value is 900 pixels. Minimum value is 600 pixels.
finished_at : string/time
The time that the job’s last run finished.
parent_id : integer
The ID of the parent job that will trigger this snapshot.
-
post(**kwargs)¶ Create a report
Parameters: provide_api_key : boolean, optional
Allow the report to provide an API key to front-end code.
script_id : integer, optional
The ID of the job (a script or a query) used to create this report.
app_state : dict, optional
Any application state blob for this report.
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
template_id : integer, optional
The ID of the template used for this report.
code_body : string, optional
The code for the report visualization.
name : string, optional
The name of the report.
Returns: provide_api_key : boolean
Whether the report requests an API Key from the report viewer.
config : string
Any configuration metadata for this report.
state : string
The status of the report’s last run.
script : dict:
- sql : string The raw SQL query for the script. - name : string The name of the script. - id : integer The ID for the script.
updated_at : string/time
valid_output_file : boolean
Whether the job (a script or a query) that backs the report currently has a valid output file.
tableau_id : integer
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
job_path : string
The link to details of the job that backs this report.
auth_thumbnail_url : string
URL for a thumbnail of the report.
template_id : integer
The ID of the template used for this report.
auth_code_url : string
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
id : integer
The ID of this report.
api_key_id : integer
The ID of the API key. Can be used for auditing API use by this report.
finished_at : string/time
The time that the report’s last run finished.
auth_data_url : string
api_key : string
A Civis API key that can be used by this report.
projects : list:
A list of projects containing the report. - name : string The name of the project. - id : integer The ID for the project.
archived : string
The archival status of the requested object(s).
created_at : string/time
app_state : dict
Any application state blob for this report.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
name : string
The name of the report.
viz_updated_at : string/time
The time that the report’s visualization was last updated.
-
post_grants(id)¶ Grant this report the ability to perform Civis platform API operations on your behalf
Parameters: id : integer
The ID of this report.
Returns: provide_api_key : boolean
Whether the report requests an API Key from the report viewer.
config : string
Any configuration metadata for this report.
state : string
The status of the report’s last run.
script : dict:
- sql : string The raw SQL query for the script. - name : string The name of the script. - id : integer The ID for the script.
updated_at : string/time
valid_output_file : boolean
Whether the job (a script or a query) that backs the report currently has a valid output file.
tableau_id : integer
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
job_path : string
The link to details of the job that backs this report.
auth_thumbnail_url : string
URL for a thumbnail of the report.
template_id : integer
The ID of the template used for this report.
auth_code_url : string
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
id : integer
The ID of this report.
api_key_id : integer
The ID of the API key. Can be used for auditing API use by this report.
finished_at : string/time
The time that the report’s last run finished.
auth_data_url : string
api_key : string
A Civis API key that can be used by this report.
projects : list:
A list of projects containing the report. - name : string The name of the project. - id : integer The ID for the project.
archived : string
The archival status of the requested object(s).
created_at : string/time
app_state : dict
Any application state blob for this report.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
name : string
The name of the report.
viz_updated_at : string/time
The time that the report’s visualization was last updated.
-
post_snapshots(id, **kwargs)¶ Generate and optionally email a snapshot of the specified report
Parameters: id : integer
The ID of this report.
parent_id : integer, optional
The ID of the parent job that will trigger this snapshot.
send_email_on_completion : boolean, optional
Whether the job will send emails on completion.
email_subject : string, optional
Subject for Email.
state : string, optional
The status of the job’s last run.
recipient_email_addresses : string, optional
Email addresses to send report to, comma separated.
width : integer, optional
The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
email_template : string, optional
Custom email template.
height : integer, optional
The height of the cropped snapshot image in screen pixels. The default value is 900 pixels. Minimum value is 600 pixels.
finished_at : string/time, optional
The time that the job’s last run finished.
Returns: schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
send_email_on_completion : boolean
Whether the job will send emails on completion.
email_subject : string
Subject for Email.
state : string
The status of the job’s last run.
email_template : string
Custom email template.
width : integer
The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.
id : integer
The ID of this report.
recipient_email_addresses : string
Email addresses to send report to, comma separated.
height : integer
The height of the cropped snapshot image in screen pixels. The default value is 900 pixels. Minimum value is 600 pixels.
finished_at : string/time
The time that the job’s last run finished.
parent_id : integer
The ID of the parent job that will trigger this snapshot.
-
put_archive(id, status)¶ Update the archive status of this object
Parameters: id : integer
The ID of the object.
status : boolean
The desired archived status of the object.
Returns: provide_api_key : boolean
Whether the report requests an API Key from the report viewer.
config : string
Any configuration metadata for this report.
state : string
The status of the report’s last run.
script : dict:
- sql : string The raw SQL query for the script. - name : string The name of the script. - id : integer The ID for the script.
updated_at : string/time
valid_output_file : boolean
Whether the job (a script or a query) that backs the report currently has a valid output file.
tableau_id : integer
user : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
job_path : string
The link to details of the job that backs this report.
auth_thumbnail_url : string
URL for a thumbnail of the report.
template_id : integer
The ID of the template used for this report.
auth_code_url : string
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
id : integer
The ID of this report.
api_key_id : integer
The ID of the API key. Can be used for auditing API use by this report.
finished_at : string/time
The time that the report’s last run finished.
auth_data_url : string
api_key : string
A Civis API key that can be used by this report.
projects : list:
A list of projects containing the report. - name : string The name of the project. - id : integer The ID for the project.
archived : string
The archival status of the requested object(s).
created_at : string/time
app_state : dict
Any application state blob for this report.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
name : string
The name of the report.
viz_updated_at : string/time
The time that the report’s visualization was last updated.
-
put_projects(id, project_id)¶ Add a Report to a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Set the permissions groups has on this object
Parameters: id : integer
ID of the resource to be shared
permission_level : string
Options are: “read”, “write”, or “manage”
group_ids : list
An array of one or more group IDs
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
Set the permissions users have on this object
Parameters: id : integer
ID of the resource to be shared
user_ids : list
An array of one or more user IDs
permission_level : string
Options are: “read”, “write”, or “manage”
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
Scripts¶
-
class
Scripts(session, return_type='civis')¶ Methods
delete_containers_projects(id, project_id)Remove a container docker from a project delete_containers_runs(id, run_id)Cancel a run delete_containers_shares_groups(id, group_id)Revoke the permissions a group has on this object delete_containers_shares_users(id, user_id)Revoke the permissions a user has on this object delete_custom_projects(id, project_id)Remove a Job from a project delete_custom_runs(id, run_id)Cancel a run delete_custom_shares_groups(id, group_id)Revoke the permissions a group has on this object delete_custom_shares_users(id, user_id)Revoke the permissions a user has on this object delete_javascript_projects(id, project_id)Remove a scripted sql from a project delete_javascript_runs(id, run_id)Cancel a run delete_javascript_shares_groups(id, group_id)Revoke the permissions a group has on this object delete_javascript_shares_users(id, user_id)Revoke the permissions a user has on this object delete_python3_projects(id, project_id)Remove a python docker from a project delete_python3_runs(id, run_id)Cancel a run delete_python3_shares_groups(id, group_id)Revoke the permissions a group has on this object delete_python3_shares_users(id, user_id)Revoke the permissions a user has on this object delete_r_projects(id, project_id)Remove a r docker from a project delete_r_runs(id, run_id)Cancel a run delete_r_shares_groups(id, group_id)Revoke the permissions a group has on this object delete_r_shares_users(id, user_id)Revoke the permissions a user has on this object delete_sql_projects(id, project_id)Remove a scripts from a project delete_sql_runs(id, run_id)Cancel a run delete_sql_shares_groups(id, group_id)Revoke the permissions a group has on this object delete_sql_shares_users(id, user_id)Revoke the permissions a user has on this object get(id)Get details about a script get_containers(id)View a container get_containers_runs(id, run_id)Check status of a run get_custom(id)Get a CustomScript get_custom_runs(id, run_id)Check status of a run get_javascript(id)Get a JavaScript Script get_javascript_runs(id, run_id)Check status of a run get_python3(id)Get a Python Script get_python3_runs(id, run_id)Check status of a run get_r(id)Get an R Script get_r_runs(id, run_id)Check status of a run get_sql(id)Get a SQL script get_sql_runs(id, run_id)Check status of a run list(**kwargs)List scripts list_containers_projects(id)List the projects a container docker belongs to list_containers_runs(id, **kwargs)List runs for the given container list_containers_runs_logs(id, run_id, **kwargs)Get the logs for a run list_containers_runs_outputs(id, run_id, ...)List the outputs for a run list_containers_shares(id)List users and groups permissioned on this object list_custom(**kwargs)List Custom Scripts list_custom_projects(id)List the projects a Job belongs to list_custom_runs(id, **kwargs)List runs for the given custom list_custom_runs_logs(id, run_id, **kwargs)Get the logs for a run list_custom_runs_outputs(id, run_id, **kwargs)List the outputs for a run list_custom_shares(id)List users and groups permissioned on this object list_history(id)Get the run history and outputs of this script list_javascript_projects(id)List the projects a scripted sql belongs to list_javascript_runs(id, **kwargs)List runs for the given javascript list_javascript_runs_logs(id, run_id, **kwargs)Get the logs for a run list_javascript_runs_outputs(id, run_id, ...)List the outputs for a run list_javascript_shares(id)List users and groups permissioned on this object list_python3_projects(id)List the projects a python docker belongs to list_python3_runs(id, **kwargs)List runs for the given python list_python3_runs_logs(id, run_id, **kwargs)Get the logs for a run list_python3_runs_outputs(id, run_id, **kwargs)List the outputs for a run list_python3_shares(id)List users and groups permissioned on this object list_r_projects(id)List the projects a r docker belongs to list_r_runs(id, **kwargs)List runs for the given r list_r_runs_logs(id, run_id, **kwargs)Get the logs for a run list_r_runs_outputs(id, run_id, **kwargs)List the outputs for a run list_r_shares(id)List users and groups permissioned on this object list_sql_projects(id)List the projects a scripts belongs to list_sql_runs(id, **kwargs)List runs for the given sql list_sql_runs_logs(id, run_id, **kwargs)Get the logs for a run list_sql_runs_outputs(id, run_id, **kwargs)List the outputs for a run list_sql_shares(id)List users and groups permissioned on this object list_types()List available script types patch(id, **kwargs)Update a script patch_containers(id, **kwargs)Update a container patch_containers_runs(id, run_id, **kwargs)Update a run patch_custom(id, **kwargs)Update some attributes of this CustomScript patch_javascript(id, **kwargs)Update some attributes of this JavaScript Script patch_python3(id, **kwargs)Update some attributes of this Python Script patch_r(id, **kwargs)Update some attributes of this R Script patch_sql(id, **kwargs)Update some attributes of this SQL script post(sql, remote_host_id, credential_id, ...)Create a script post_cancel(id)Cancel a run post_containers(required_resources, ...)Create a container post_containers_runs(id)Start a run post_containers_runs_heartbeats(id, run_id)Indicate that the given run is being handled post_containers_runs_logs(id, run_id, **kwargs)Add log messages post_containers_runs_outputs(id, run_id, ...)Add an output for a run post_custom(from_template_id, **kwargs)Create a CustomScript post_custom_runs(id)Start a run post_custom_runs_outputs(id, run_id, ...)Add an output for a run post_javascript(source, credential_id, ...)Create a JavaScript Script post_javascript_runs(id)Start a run post_javascript_runs_outputs(id, run_id, ...)Add an output for a run post_python3(source, name, **kwargs)Create a Python Script post_python3_runs(id)Start a run post_python3_runs_outputs(id, run_id, ...)Add an output for a run post_r(source, name, **kwargs)Create an R Script post_r_runs(id)Start a run post_r_runs_outputs(id, run_id, object_id, ...)Add an output for a run post_run(id)Run a script post_sql(sql, credential_id, remote_host_id, ...)Create a SQL script post_sql_runs(id)Start a run put_containers(id, required_resources, ...)Edit a container put_containers_archive(id, status)Update the archive status of this object put_containers_projects(id, project_id)Add a container docker to a project put_containers_shares_groups(id, ...)Set the permissions groups has on this object put_containers_shares_users(id, user_ids, ...)Set the permissions users have on this object put_custom(id, **kwargs)Replace all attributes of this CustomScript put_custom_archive(id, status)Update the archive status of this object put_custom_projects(id, project_id)Add a Job to a project put_custom_shares_groups(id, ...)Set the permissions groups has on this object put_custom_shares_users(id, user_ids, ...)Set the permissions users have on this object put_javascript(id, source, credential_id, ...)Replace all attributes of this JavaScript Script put_javascript_archive(id, status)Update the archive status of this object put_javascript_projects(id, project_id)Add a scripted sql to a project put_javascript_shares_groups(id, ...)Set the permissions groups has on this object put_javascript_shares_users(id, user_ids, ...)Set the permissions users have on this object put_python3(id, source, name, **kwargs)Replace all attributes of this Python Script put_python3_archive(id, status)Update the archive status of this object put_python3_projects(id, project_id)Add a python docker to a project put_python3_shares_groups(id, ...)Set the permissions groups has on this object put_python3_shares_users(id, user_ids, ...)Set the permissions users have on this object put_r(id, source, name, **kwargs)Replace all attributes of this R Script put_r_archive(id, status)Update the archive status of this object put_r_projects(id, project_id)Add a r docker to a project put_r_shares_groups(id, permission_level, ...)Set the permissions groups has on this object put_r_shares_users(id, user_ids, ...)Set the permissions users have on this object put_sql(id, sql, credential_id, ...)Replace all attributes of this SQL script put_sql_archive(id, status)Update the archive status of this object put_sql_projects(id, project_id)Add a scripts to a project put_sql_shares_groups(id, permission_level, ...)Set the permissions groups has on this object put_sql_shares_users(id, user_ids, ...)Set the permissions users have on this object -
delete_containers_projects(id, project_id)¶ Remove a container docker from a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
-
delete_containers_runs(id, run_id)¶ Cancel a run
Parameters: id : integer
The ID of the container.
run_id : integer
The ID of the run.
Returns: None
Response code 202: success
Revoke the permissions a group has on this object
Parameters: id : integer
ID of the resource to be revoked
group_id : integer
ID of the group
Returns: None
Response code 204: success
Revoke the permissions a user has on this object
Parameters: id : integer
ID of the resource to be revoked
user_id : integer
ID of the user
Returns: None
Response code 204: success
-
delete_custom_projects(id, project_id)¶ Remove a Job from a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
-
delete_custom_runs(id, run_id)¶ Cancel a run
Parameters: id : integer
The ID of the custom.
run_id : integer
The ID of the run.
Returns: None
Response code 202: success
Revoke the permissions a group has on this object
Parameters: id : integer
ID of the resource to be revoked
group_id : integer
ID of the group
Returns: None
Response code 204: success
Revoke the permissions a user has on this object
Parameters: id : integer
ID of the resource to be revoked
user_id : integer
ID of the user
Returns: None
Response code 204: success
-
delete_javascript_projects(id, project_id)¶ Remove a scripted sql from a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
-
delete_javascript_runs(id, run_id)¶ Cancel a run
Parameters: id : integer
The ID of the javascript.
run_id : integer
The ID of the run.
Returns: None
Response code 202: success
Revoke the permissions a group has on this object
Parameters: id : integer
ID of the resource to be revoked
group_id : integer
ID of the group
Returns: None
Response code 204: success
Revoke the permissions a user has on this object
Parameters: id : integer
ID of the resource to be revoked
user_id : integer
ID of the user
Returns: None
Response code 204: success
-
delete_python3_projects(id, project_id)¶ Remove a python docker from a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
-
delete_python3_runs(id, run_id)¶ Cancel a run
Parameters: id : integer
The ID of the python.
run_id : integer
The ID of the run.
Returns: None
Response code 202: success
Revoke the permissions a group has on this object
Parameters: id : integer
ID of the resource to be revoked
group_id : integer
ID of the group
Returns: None
Response code 204: success
Revoke the permissions a user has on this object
Parameters: id : integer
ID of the resource to be revoked
user_id : integer
ID of the user
Returns: None
Response code 204: success
-
delete_r_projects(id, project_id)¶ Remove a r docker from a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
-
delete_r_runs(id, run_id)¶ Cancel a run
Parameters: id : integer
The ID of the r.
run_id : integer
The ID of the run.
Returns: None
Response code 202: success
Revoke the permissions a group has on this object
Parameters: id : integer
ID of the resource to be revoked
group_id : integer
ID of the group
Returns: None
Response code 204: success
Revoke the permissions a user has on this object
Parameters: id : integer
ID of the resource to be revoked
user_id : integer
ID of the user
Returns: None
Response code 204: success
-
delete_sql_projects(id, project_id)¶ Remove a scripts from a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
-
delete_sql_runs(id, run_id)¶ Cancel a run
Parameters: id : integer
The ID of the sql.
run_id : integer
The ID of the run.
Returns: None
Response code 202: success
Revoke the permissions a group has on this object
Parameters: id : integer
ID of the resource to be revoked
group_id : integer
ID of the group
Returns: None
Response code 204: success
Revoke the permissions a user has on this object
Parameters: id : integer
ID of the resource to be revoked
user_id : integer
ID of the user
Returns: None
Response code 204: success
-
get(id)¶ Get details about a script
Parameters: id : integer
The ID for the script.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time this script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
template_dependents_count : integer
How many other scripts use this one as a template.
sql : string
The raw SQL query for the script.
expanded_arguments : dict
Expanded arguments for use in injecting into different environments.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
template_script_id : integer
The ID of the template script, if any.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of script.
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
get_containers(id)¶ View a container
Parameters: id : integer
The ID for the script.
Returns: user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
target_project_id : integer
Target project to which script outputs will be added.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template script.
template_dependents_count : integer
How many other scripts use this one as a template.
remote_host_credential_id : integer
The id of the database credentials to pass into the environment of the container.
docker_image_tag : string
The tag of the docker image to pull from DockerHub (default: latest).
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
repo_http_uri : string
The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
docker_command : string
The command to run on the container. Will be run via sh as: [“sh”, “-c”, dockerCommand]
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g Container)
docker_image_name : string
The name of the docker image to pull from DockerHub.
git_credential_id : integer
The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used. Unnecessary if no git repo is specified or the git repo is public.
name : string
The name of the container.
repo_ref : string
The tag or branch of the github repo to clone into the container.
-
get_containers_runs(id, run_id)¶ Check status of a run
Parameters: id : integer
The ID of the container.
run_id : integer
The ID of the run.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
id : integer
The ID of the run.
container_id : integer
The ID of the container.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
get_custom(id)¶ Get a CustomScript
Parameters: id : integer
Returns: state : string
The status of the script’s last run.
target_project_id : integer
Target project to which script outputs will be added.
updated_at : string/time
The time the script was last updated.
from_template_id : integer
The ID of the template script.
credential_id : integer
The credential that this script will use.
code_preview : string
The code that this script will run with arguments inserted.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer
The ID of the parent job that will trigger this script
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
archived : string
The archival status of the requested object(s).
id : integer
The ID for the script.
finished_at : string/time
The time that the script’s last run finished.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
remote_host_id : integer
The remote host ID that this script will connect to.
type : string
The type of the script (e.g Custom)
name : string
The name of the script.
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
-
get_custom_runs(id, run_id)¶ Check status of a run
Parameters: id : integer
The ID of the custom.
run_id : integer
The ID of the run.
Returns: is_cancel_requested : boolean
True if run cancel requested, else false.
state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
id : integer
The ID of the run.
custom_id : integer
The ID of the custom.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
get_javascript(id)¶ Get a JavaScript Script
Parameters: id : integer
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
credential_id : integer
The credential that this script will use.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
remote_host_id : integer
The remote host ID that this script will connect to.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
get_javascript_runs(id, run_id)¶ Check status of a run
Parameters: id : integer
The ID of the javascript.
run_id : integer
The ID of the run.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
javascript_id : integer
The ID of the javascript.
id : integer
The ID of the run.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
get_python3(id)¶ Get a Python Script
Parameters: id : integer
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
get_python3_runs(id, run_id)¶ Check status of a run
Parameters: id : integer
The ID of the python.
run_id : integer
The ID of the run.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
python_id : integer
The ID of the python.
id : integer
The ID of the run.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
get_r(id)¶ Get an R Script
Parameters: id : integer
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
get_r_runs(id, run_id)¶ Check status of a run
Parameters: id : integer
The ID of the r.
run_id : integer
The ID of the run.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
r_id : integer
The ID of the r.
is_cancel_requested : boolean
True if run cancel requested, else false.
id : integer
The ID of the run.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
finished_at : string/time
The time the last run completed.
-
get_sql(id)¶ Get a SQL script
Parameters: id : integer
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
credential_id : integer
The credential that this script will use.
remote_host_id : integer
The remote host ID that this script will connect to.
template_dependents_count : integer
How many other scripts use this one as a template.
sql : string
The raw SQL query for the script.
expanded_arguments : dict
Expanded arguments for use in injecting into different environments.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
csv_settings : dict:
- force_multifile : boolean Whether or not the csv should be split into multiple files. Default: false - include_header : boolean Whether or not to include headers in the output data. Default: true - unquoted : boolean Whether or not to quote fields. Default: false - column_delimiter : string Which delimiter to use, one of "comma", "tab", or "pipe". Default: comma - compression : string The type of compression to use, if any, one of "none", "zip", or "gzip". Default: gzip - filename_prefix : string A user specified filename prefix for the output file to have. Default: null
code_preview : string
The code that this script will run with arguments inserted.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
get_sql_runs(id, run_id)¶ Check status of a run
Parameters: id : integer
The ID of the sql.
run_id : integer
The ID of the run.
Returns: state : string
The state of this run.
sql_id : integer
The ID of this sql.
id : integer
The ID of this run.
output : list:
A list of the outputs of this script. - output_name : string The name of the output file. - file_id : integer The unique ID of the output file. - path : string The temporary link to download this output file, valid for 36 hours.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time that this run finished.
error : string
The error message for this run, if present.
started_at : string/time
The time the last run started.
-
list(**kwargs)¶ List scripts
Parameters: type : string, optional
If specified, return objects of these types. The valid types are ‘sql’, ‘python3’, ‘r’, and ‘javascript’.
author : string, optional
If specified, return objects from this author. Must use user IDs. A comma separated list of IDs is also accepted to return objects from multiple authors.
status : string, optional
If specified, returns objects with one of these statuses. It accepts a comma-separated list, possible values are ‘running’, ‘failed’, ‘succeeded’, ‘idle’, ‘scheduled’.
archived : string, optional
The archival status of the requested object(s).
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: archived : string
The archival status of the requested object(s).
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
template_script_id : integer
The ID of the template script, if any.
is_template : boolean
Whether others scripts use this one as a template.
id : integer
The ID for the script.
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
time_zone : string
The time zone of this script.
from_template_id : integer
The ID of the template this script uses, if any.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
parent_id : integer
The ID of the parent job that will trigger this script
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
The name of the script.
finished_at : string/time
The time that the script’s last run finished.
-
list_containers_projects(id)¶ List the projects a container docker belongs to
Parameters: id : integer
The ID of the resource.
Returns: updated_at : string/time
description : string
A description of the project
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
id : integer
The ID for this project.
auto_share : boolean
archived : string
The archival status of the requested object(s).
name : string
The name of this project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
-
list_containers_runs(id, **kwargs)¶ List runs for the given container
Parameters: id : integer
The ID of the container.
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 100.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to id. Must be one of: id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
id : integer
The ID of the run.
container_id : integer
The ID of the container.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
list_containers_runs_logs(id, run_id, **kwargs)¶ Get the logs for a run
Parameters: id : integer
The ID of the container.
run_id : integer
The ID of the run.
last_id : integer, optional
The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.
limit : integer, optional
The maximum number of log messages to return. Default of 10000.
Returns: message : string
The log message.
level : string
The level of the log. One of unknown,fatal,error,warn,info,debug.
created_at : string/date-time
The time the log was created.
id : integer
The ID of the log.
-
list_containers_runs_outputs(id, run_id, **kwargs)¶ List the outputs for a run
Parameters: id : integer
The ID of the output.
run_id : integer
The ID of the run.
limit : integer, optional
Number of results to return. Defaults to its maximum of 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
link : string
The link to retrieve the output object.
name : string
The name of the output object.
List users and groups permissioned on this object
Parameters: id : integer
The ID of the object.
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
list_custom(**kwargs)¶ List Custom Scripts
Parameters: from_template_id : integer, optional
The template script that this app uses.
author : string, optional
If specified, return objects from this author. Must use user IDs. A comma separated list of IDs is also accepted to return objects from multiple authors.
status : string, optional
If specified, returns objects with one of these statuses. It accepts a comma-separated list, possible values are ‘running’, ‘failed’, ‘succeeded’, ‘idle’, ‘scheduled’.
archived : string, optional
The archival status of the requested object(s).
limit : integer, optional
Number of results to return. Defaults to its maximum of 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: archived : string
The archival status of the requested object(s).
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
id : integer
The ID for the script.
finished_at : string/time
The time that the script’s last run finished.
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
time_zone : string
The time zone of this script.
from_template_id : integer
The ID of the template script.
type : string
The type of the script (e.g Custom)
parent_id : integer
The ID of the parent job that will trigger this script
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
The name of the script.
-
list_custom_projects(id)¶ List the projects a Job belongs to
Parameters: id : integer
The ID of the resource.
Returns: updated_at : string/time
description : string
A description of the project
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
id : integer
The ID for this project.
auto_share : boolean
archived : string
The archival status of the requested object(s).
name : string
The name of this project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
-
list_custom_runs(id, **kwargs)¶ List runs for the given custom
Parameters: id : integer
The ID of the custom.
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 100.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to id. Must be one of: id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: is_cancel_requested : boolean
True if run cancel requested, else false.
state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
id : integer
The ID of the run.
custom_id : integer
The ID of the custom.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
list_custom_runs_logs(id, run_id, **kwargs)¶ Get the logs for a run
Parameters: id : integer
The ID of the custom.
run_id : integer
The ID of the run.
last_id : integer, optional
The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.
limit : integer, optional
The maximum number of log messages to return. Default of 10000.
Returns: message : string
The log message.
level : string
The level of the log. One of unknown,fatal,error,warn,info,debug.
created_at : string/date-time
The time the log was created.
id : integer
The ID of the log.
-
list_custom_runs_outputs(id, run_id, **kwargs)¶ List the outputs for a run
Parameters: id : integer
The ID of the output.
run_id : integer
The ID of the run.
limit : integer, optional
Number of results to return. Defaults to its maximum of 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
link : string
The link to retrieve the output object.
name : string
The name of the output object.
List users and groups permissioned on this object
Parameters: id : integer
The ID of the object.
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
list_history(id)¶ Get the run history and outputs of this script
Parameters: id : integer
The ID for the script.
Returns: state : string
The state of this run.
sql_id : integer
The ID of this sql.
id : integer
The ID of this run.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time that this run finished.
output : list:
A list of the outputs of this script. - output_name : string The name of the output file. - file_id : integer The unique ID of the output file. - path : string The temporary link to download this output file, valid for 36 hours.
error : string
The error message for this run, if present.
-
list_javascript_projects(id)¶ List the projects a scripted sql belongs to
Parameters: id : integer
The ID of the resource.
Returns: updated_at : string/time
description : string
A description of the project
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
id : integer
The ID for this project.
auto_share : boolean
archived : string
The archival status of the requested object(s).
name : string
The name of this project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
-
list_javascript_runs(id, **kwargs)¶ List runs for the given javascript
Parameters: id : integer
The ID of the javascript.
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 100.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to id. Must be one of: id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
javascript_id : integer
The ID of the javascript.
id : integer
The ID of the run.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
list_javascript_runs_logs(id, run_id, **kwargs)¶ Get the logs for a run
Parameters: id : integer
The ID of the javascript.
run_id : integer
The ID of the run.
last_id : integer, optional
The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.
limit : integer, optional
The maximum number of log messages to return. Default of 10000.
Returns: message : string
The log message.
level : string
The level of the log. One of unknown,fatal,error,warn,info,debug.
created_at : string/date-time
The time the log was created.
id : integer
The ID of the log.
-
list_javascript_runs_outputs(id, run_id, **kwargs)¶ List the outputs for a run
Parameters: id : integer
The ID of the output.
run_id : integer
The ID of the run.
limit : integer, optional
Number of results to return. Defaults to its maximum of 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
link : string
The link to retrieve the output object.
name : string
The name of the output object.
List users and groups permissioned on this object
Parameters: id : integer
The ID of the object.
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
list_python3_projects(id)¶ List the projects a python docker belongs to
Parameters: id : integer
The ID of the resource.
Returns: updated_at : string/time
description : string
A description of the project
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
id : integer
The ID for this project.
auto_share : boolean
archived : string
The archival status of the requested object(s).
name : string
The name of this project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
-
list_python3_runs(id, **kwargs)¶ List runs for the given python
Parameters: id : integer
The ID of the python.
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 100.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to id. Must be one of: id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
python_id : integer
The ID of the python.
id : integer
The ID of the run.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
list_python3_runs_logs(id, run_id, **kwargs)¶ Get the logs for a run
Parameters: id : integer
The ID of the python.
run_id : integer
The ID of the run.
last_id : integer, optional
The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.
limit : integer, optional
The maximum number of log messages to return. Default of 10000.
Returns: message : string
The log message.
level : string
The level of the log. One of unknown,fatal,error,warn,info,debug.
created_at : string/date-time
The time the log was created.
id : integer
The ID of the log.
-
list_python3_runs_outputs(id, run_id, **kwargs)¶ List the outputs for a run
Parameters: id : integer
The ID of the output.
run_id : integer
The ID of the run.
limit : integer, optional
Number of results to return. Defaults to its maximum of 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
link : string
The link to retrieve the output object.
name : string
The name of the output object.
List users and groups permissioned on this object
Parameters: id : integer
The ID of the object.
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
list_r_projects(id)¶ List the projects a r docker belongs to
Parameters: id : integer
The ID of the resource.
Returns: updated_at : string/time
description : string
A description of the project
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
id : integer
The ID for this project.
auto_share : boolean
archived : string
The archival status of the requested object(s).
name : string
The name of this project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
-
list_r_runs(id, **kwargs)¶ List runs for the given r
Parameters: id : integer
The ID of the r.
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 100.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to id. Must be one of: id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
r_id : integer
The ID of the r.
is_cancel_requested : boolean
True if run cancel requested, else false.
id : integer
The ID of the run.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
finished_at : string/time
The time the last run completed.
-
list_r_runs_logs(id, run_id, **kwargs)¶ Get the logs for a run
Parameters: id : integer
The ID of the r.
run_id : integer
The ID of the run.
last_id : integer, optional
The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.
limit : integer, optional
The maximum number of log messages to return. Default of 10000.
Returns: message : string
The log message.
level : string
The level of the log. One of unknown,fatal,error,warn,info,debug.
created_at : string/date-time
The time the log was created.
id : integer
The ID of the log.
-
list_r_runs_outputs(id, run_id, **kwargs)¶ List the outputs for a run
Parameters: id : integer
The ID of the output.
run_id : integer
The ID of the run.
limit : integer, optional
Number of results to return. Defaults to its maximum of 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
link : string
The link to retrieve the output object.
name : string
The name of the output object.
List users and groups permissioned on this object
Parameters: id : integer
The ID of the object.
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
list_sql_projects(id)¶ List the projects a scripts belongs to
Parameters: id : integer
The ID of the resource.
Returns: updated_at : string/time
description : string
A description of the project
users : list:
Users who can see the project - username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
id : integer
The ID for this project.
auto_share : boolean
archived : string
The archival status of the requested object(s).
name : string
The name of this project.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
-
list_sql_runs(id, **kwargs)¶ List runs for the given sql
Parameters: id : integer
The ID of the sql.
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 100.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to id. Must be one of: id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: state : string
The state of this run.
sql_id : integer
The ID of this sql.
id : integer
The ID of this run.
output : list:
A list of the outputs of this script. - output_name : string The name of the output file. - file_id : integer The unique ID of the output file. - path : string The temporary link to download this output file, valid for 36 hours.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time that this run finished.
error : string
The error message for this run, if present.
started_at : string/time
The time the last run started.
-
list_sql_runs_logs(id, run_id, **kwargs)¶ Get the logs for a run
Parameters: id : integer
The ID of the sql.
run_id : integer
The ID of the run.
last_id : integer, optional
The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.
limit : integer, optional
The maximum number of log messages to return. Default of 10000.
Returns: message : string
The log message.
level : string
The level of the log. One of unknown,fatal,error,warn,info,debug.
created_at : string/date-time
The time the log was created.
id : integer
The ID of the log.
-
list_sql_runs_outputs(id, run_id, **kwargs)¶ List the outputs for a run
Parameters: id : integer
The ID of the output.
run_id : integer
The ID of the run.
limit : integer, optional
Number of results to return. Defaults to its maximum of 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
link : string
The link to retrieve the output object.
name : string
The name of the output object.
List users and groups permissioned on this object
Parameters: id : integer
The ID of the object.
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
list_types()¶ List available script types
Returns: name : string
The name of the type.
-
patch(id, **kwargs)¶ Update a script
Parameters: id : integer
The ID for the script.
sql : string, optional
The raw SQL query for the script.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. Cannot be set if this script uses a template script. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_id : integer, optional
The ID of the template script, if any. A script cannot both have a template script and be a template for other scripts.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
name : string, optional
The name of the script.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time this script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
template_dependents_count : integer
How many other scripts use this one as a template.
sql : string
The raw SQL query for the script.
expanded_arguments : dict
Expanded arguments for use in injecting into different environments.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
template_script_id : integer
The ID of the template script, if any.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of script.
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
patch_containers(id, **kwargs)¶ Update a container
Parameters: id : integer
The ID for the script.
target_project_id : integer, optional
Target project to which script outputs will be added.
required_resources : dict, optional:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares.
docker_image_name : string, optional
The name of the docker image to pull from DockerHub.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
remote_host_credential_id : integer, optional
The id of the database credentials to pass into the environment of the container.
docker_command : string, optional
The command to run on the container. Will be run via sh as: [“sh”, “-c”, dockerCommand]
docker_image_tag : string, optional
The tag of the docker image to pull from DockerHub (default: latest).
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
time_zone : string, optional
The time zone of this script.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
repo_http_uri : string, optional
The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
git_credential_id : integer, optional
The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used. Unnecessary if no git repo is specified or the git repo is public.
name : string, optional
The name of the container.
repo_ref : string, optional
The tag or branch of the github repo to clone into the container.
Returns: user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
target_project_id : integer
Target project to which script outputs will be added.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template script.
template_dependents_count : integer
How many other scripts use this one as a template.
remote_host_credential_id : integer
The id of the database credentials to pass into the environment of the container.
docker_image_tag : string
The tag of the docker image to pull from DockerHub (default: latest).
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
repo_http_uri : string
The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
docker_command : string
The command to run on the container. Will be run via sh as: [“sh”, “-c”, dockerCommand]
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g Container)
docker_image_name : string
The name of the docker image to pull from DockerHub.
git_credential_id : integer
The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used. Unnecessary if no git repo is specified or the git repo is public.
name : string
The name of the container.
repo_ref : string
The tag or branch of the github repo to clone into the container.
-
patch_containers_runs(id, run_id, **kwargs)¶ Update a run
Parameters: id : integer
The ID for the script.
run_id : integer
The ID of the script run.
bocce_started_at : string/date-time, optional
The time when a bocce worker began executing the script.
state : string, optional
The state of the script.
bocce_accepted_at : string/date-time, optional
The time when a bocce worker began processing the script.
Returns: None
Response code 204: success
-
patch_custom(id, **kwargs)¶ Update some attributes of this CustomScript
Parameters: id : integer
The ID for the script.
remote_host_id : integer, optional
The remote host ID that this script will connect to.
target_project_id : integer, optional
Target project to which script outputs will be added.
time_zone : string, optional
The time zone of this script.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
credential_id : integer, optional
The credential that this script will use.
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
name : string, optional
The name of the script.
Returns: state : string
The status of the script’s last run.
target_project_id : integer
Target project to which script outputs will be added.
updated_at : string/time
The time the script was last updated.
from_template_id : integer
The ID of the template script.
credential_id : integer
The credential that this script will use.
code_preview : string
The code that this script will run with arguments inserted.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer
The ID of the parent job that will trigger this script
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
archived : string
The archival status of the requested object(s).
id : integer
The ID for the script.
finished_at : string/time
The time that the script’s last run finished.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
remote_host_id : integer
The remote host ID that this script will connect to.
type : string
The type of the script (e.g Custom)
name : string
The name of the script.
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
-
patch_javascript(id, **kwargs)¶ Update some attributes of this JavaScript Script
Parameters: id : integer
The ID for the script.
next_run_at : string/time, optional
The time of the next scheduled run.
source : string, optional
The body/text of the script.
credential_id : integer, optional
The credential that this script will use.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
remote_host_id : integer, optional
The remote host ID that this script will connect to.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
time_zone : string, optional
The time zone of this script.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
name : string, optional
The name of the script.
target_project_id : integer, optional
Target project to which script outputs will be added.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
credential_id : integer
The credential that this script will use.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
remote_host_id : integer
The remote host ID that this script will connect to.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
patch_python3(id, **kwargs)¶ Update some attributes of this Python Script
Parameters: id : integer
The ID for the script.
next_run_at : string/time, optional
The time of the next scheduled run.
source : string, optional
The body/text of the script.
required_resources : dict, optional:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
time_zone : string, optional
The time zone of this script.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
name : string, optional
The name of the script.
target_project_id : integer, optional
Target project to which script outputs will be added.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
patch_r(id, **kwargs)¶ Update some attributes of this R Script
Parameters: id : integer
The ID for the script.
next_run_at : string/time, optional
The time of the next scheduled run.
source : string, optional
The body/text of the script.
required_resources : dict, optional:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
time_zone : string, optional
The time zone of this script.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
name : string, optional
The name of the script.
target_project_id : integer, optional
Target project to which script outputs will be added.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
patch_sql(id, **kwargs)¶ Update some attributes of this SQL script
Parameters: id : integer
The ID for the script.
next_run_at : string/time, optional
The time of the next scheduled run.
sql : string, optional
The raw SQL query for the script.
credential_id : integer, optional
The credential that this script will use.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
remote_host_id : integer, optional
The remote host ID that this script will connect to.
csv_settings : dict, optional:
- force_multifile : boolean Whether or not the csv should be split into multiple files. Default: false - include_header : boolean Whether or not to include headers in the output data. Default: true - unquoted : boolean Whether or not to quote fields. Default: false - column_delimiter : string Which delimiter to use, one of "comma", "tab", or "pipe". Default: comma - compression : string The type of compression to use, if any, one of "none", "zip", or "gzip". Default: gzip - filename_prefix : string A user specified filename prefix for the output file to have. Default: null
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
time_zone : string, optional
The time zone of this script.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
name : string, optional
The name of the script.
target_project_id : integer, optional
Target project to which script outputs will be added.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
credential_id : integer
The credential that this script will use.
remote_host_id : integer
The remote host ID that this script will connect to.
template_dependents_count : integer
How many other scripts use this one as a template.
sql : string
The raw SQL query for the script.
expanded_arguments : dict
Expanded arguments for use in injecting into different environments.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
csv_settings : dict:
- force_multifile : boolean Whether or not the csv should be split into multiple files. Default: false - include_header : boolean Whether or not to include headers in the output data. Default: true - unquoted : boolean Whether or not to quote fields. Default: false - column_delimiter : string Which delimiter to use, one of "comma", "tab", or "pipe". Default: comma - compression : string The type of compression to use, if any, one of "none", "zip", or "gzip". Default: gzip - filename_prefix : string A user specified filename prefix for the output file to have. Default: null
code_preview : string
The code that this script will run with arguments inserted.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
post(sql, remote_host_id, credential_id, name, **kwargs)¶ Create a script
Parameters: sql : string
The raw SQL query for the script.
remote_host_id : integer
The database ID.
credential_id : integer
The credential ID.
name : string
The name of the script.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. Cannot be set if this script uses a template script. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_id : integer, optional
The ID of the template script, if any. A script cannot both have a template script and be a template for other scripts.
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
template_dependents_count : integer
How many other scripts use this one as a template.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
template_script_id : integer
The ID of the template script, if any.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
post_cancel(id)¶ Cancel a run
Parameters: id : integer
The ID of the job.
Returns: is_cancel_requested : boolean
True if run cancel requested, else false.
state : string
The state of the run, one of ‘queued’, ‘running’ or ‘cancelled’.
id : integer
The ID of the run.
-
post_containers(required_resources, docker_image_name, docker_command, **kwargs)¶ Create a container
Parameters: required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares.
docker_image_name : string
The name of the docker image to pull from DockerHub.
docker_command : string
The command to run on the container. Will be run via sh as: [“sh”, “-c”, dockerCommand]
target_project_id : integer, optional
Target project to which script outputs will be added.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
remote_host_credential_id : integer, optional
The id of the database credentials to pass into the environment of the container.
docker_image_tag : string, optional
The tag of the docker image to pull from DockerHub (default: latest).
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
time_zone : string, optional
The time zone of this script.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
repo_http_uri : string, optional
The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
git_credential_id : integer, optional
The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used. Unnecessary if no git repo is specified or the git repo is public.
name : string, optional
The name of the container.
repo_ref : string, optional
The tag or branch of the github repo to clone into the container.
Returns: user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
target_project_id : integer
Target project to which script outputs will be added.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template script.
template_dependents_count : integer
How many other scripts use this one as a template.
remote_host_credential_id : integer
The id of the database credentials to pass into the environment of the container.
docker_image_tag : string
The tag of the docker image to pull from DockerHub (default: latest).
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
repo_http_uri : string
The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
docker_command : string
The command to run on the container. Will be run via sh as: [“sh”, “-c”, dockerCommand]
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g Container)
docker_image_name : string
The name of the docker image to pull from DockerHub.
git_credential_id : integer
The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used. Unnecessary if no git repo is specified or the git repo is public.
name : string
The name of the container.
repo_ref : string
The tag or branch of the github repo to clone into the container.
-
post_containers_runs(id)¶ Start a run
Parameters: id : integer
The ID of the container.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
id : integer
The ID of the run.
container_id : integer
The ID of the container.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
post_containers_runs_heartbeats(id, run_id)¶ Indicate that the given run is being handled
Parameters: id : integer
The ID of the container.
run_id : integer
The ID of the run.
Returns: None
Response code 204: success
-
post_containers_runs_logs(id, run_id, **kwargs)¶ Add log messages
Parameters: id : integer
The ID of the script.
run_id : integer
The ID of the script run.
messages : list, optional:
- level : string The log level of this message [default: info] - created_at : string/date-time - message : string The log message to store.
level : string, optional
The log level of this message [default: info]
message : string, optional
The log message to store.
Returns: None
Response code 204: success
-
post_containers_runs_outputs(id, run_id, object_id, object_type)¶ Add an output for a run
Parameters: id : integer
The ID of the output.
run_id : integer
The ID of the run.
object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
Returns: object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
link : string
The link to retrieve the output object.
name : string
The name of the output object.
-
post_custom(from_template_id, **kwargs)¶ Create a CustomScript
Parameters: from_template_id : integer
The ID of the template script.
remote_host_id : integer, optional
The remote host ID that this script will connect to.
target_project_id : integer, optional
Target project to which script outputs will be added.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
time_zone : string, optional
The time zone of this script.
credential_id : integer, optional
The credential that this script will use.
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
name : string, optional
The name of the script.
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
Returns: state : string
The status of the script’s last run.
target_project_id : integer
Target project to which script outputs will be added.
updated_at : string/time
The time the script was last updated.
from_template_id : integer
The ID of the template script.
credential_id : integer
The credential that this script will use.
code_preview : string
The code that this script will run with arguments inserted.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer
The ID of the parent job that will trigger this script
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
archived : string
The archival status of the requested object(s).
id : integer
The ID for the script.
finished_at : string/time
The time that the script’s last run finished.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
remote_host_id : integer
The remote host ID that this script will connect to.
type : string
The type of the script (e.g Custom)
name : string
The name of the script.
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
-
post_custom_runs(id)¶ Start a run
Parameters: id : integer
The ID of the custom.
Returns: is_cancel_requested : boolean
True if run cancel requested, else false.
state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
id : integer
The ID of the run.
custom_id : integer
The ID of the custom.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
post_custom_runs_outputs(id, run_id, object_id, object_type)¶ Add an output for a run
Parameters: id : integer
The ID of the output.
run_id : integer
The ID of the run.
object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
Returns: object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
link : string
The link to retrieve the output object.
name : string
The name of the output object.
-
post_javascript(source, credential_id, remote_host_id, name, **kwargs)¶ Create a JavaScript Script
Parameters: source : string
The body/text of the script.
credential_id : integer
The credential that this script will use.
remote_host_id : integer
The remote host ID that this script will connect to.
name : string
The name of the script.
next_run_at : string/time, optional
The time of the next scheduled run.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
time_zone : string, optional
The time zone of this script.
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
target_project_id : integer, optional
Target project to which script outputs will be added.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
credential_id : integer
The credential that this script will use.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
remote_host_id : integer
The remote host ID that this script will connect to.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
post_javascript_runs(id)¶ Start a run
Parameters: id : integer
The ID of the javascript.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
javascript_id : integer
The ID of the javascript.
id : integer
The ID of the run.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
post_javascript_runs_outputs(id, run_id, object_id, object_type)¶ Add an output for a run
Parameters: id : integer
The ID of the output.
run_id : integer
The ID of the run.
object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
Returns: object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
link : string
The link to retrieve the output object.
name : string
The name of the output object.
-
post_python3(source, name, **kwargs)¶ Create a Python Script
Parameters: source : string
The body/text of the script.
name : string
The name of the script.
next_run_at : string/time, optional
The time of the next scheduled run.
required_resources : dict, optional:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
time_zone : string, optional
The time zone of this script.
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
target_project_id : integer, optional
Target project to which script outputs will be added.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
post_python3_runs(id)¶ Start a run
Parameters: id : integer
The ID of the python.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
python_id : integer
The ID of the python.
id : integer
The ID of the run.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time the last run completed.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
-
post_python3_runs_outputs(id, run_id, object_id, object_type)¶ Add an output for a run
Parameters: id : integer
The ID of the output.
run_id : integer
The ID of the run.
object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
Returns: object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
link : string
The link to retrieve the output object.
name : string
The name of the output object.
-
post_r(source, name, **kwargs)¶ Create an R Script
Parameters: source : string
The body/text of the script.
name : string
The name of the script.
next_run_at : string/time, optional
The time of the next scheduled run.
required_resources : dict, optional:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
time_zone : string, optional
The time zone of this script.
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
target_project_id : integer, optional
Target project to which script outputs will be added.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
post_r_runs(id)¶ Start a run
Parameters: id : integer
The ID of the r.
Returns: state : string
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
r_id : integer
The ID of the r.
is_cancel_requested : boolean
True if run cancel requested, else false.
id : integer
The ID of the run.
error : string
The error, if any, returned by the run.
started_at : string/time
The time the last run started at.
finished_at : string/time
The time the last run completed.
-
post_r_runs_outputs(id, run_id, object_id, object_type)¶ Add an output for a run
Parameters: id : integer
The ID of the output.
run_id : integer
The ID of the run.
object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
Returns: object_id : integer
The ID of the output object.
object_type : string
The type of the output. Valid values are File, Report, Table, or Project
link : string
The link to retrieve the output object.
name : string
The name of the output object.
-
post_run(id)¶ Run a script
Parameters: id : integer
The ID for the script.
Returns: None
Response code 204: success
-
post_sql(sql, credential_id, remote_host_id, name, **kwargs)¶ Create a SQL script
Parameters: sql : string
The raw SQL query for the script.
credential_id : integer
The credential that this script will use.
remote_host_id : integer
The remote host ID that this script will connect to.
name : string
The name of the script.
next_run_at : string/time, optional
The time of the next scheduled run.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
csv_settings : dict, optional:
- force_multifile : boolean Whether or not the csv should be split into multiple files. Default: false - include_header : boolean Whether or not to include headers in the output data. Default: true - unquoted : boolean Whether or not to quote fields. Default: false - column_delimiter : string Which delimiter to use, one of "comma", "tab", or "pipe". Default: comma - compression : string The type of compression to use, if any, one of "none", "zip", or "gzip". Default: gzip - filename_prefix : string A user specified filename prefix for the output file to have. Default: null
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
time_zone : string, optional
The time zone of this script.
hidden : boolean, optional
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
target_project_id : integer, optional
Target project to which script outputs will be added.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
credential_id : integer
The credential that this script will use.
remote_host_id : integer
The remote host ID that this script will connect to.
template_dependents_count : integer
How many other scripts use this one as a template.
sql : string
The raw SQL query for the script.
expanded_arguments : dict
Expanded arguments for use in injecting into different environments.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
csv_settings : dict:
- force_multifile : boolean Whether or not the csv should be split into multiple files. Default: false - include_header : boolean Whether or not to include headers in the output data. Default: true - unquoted : boolean Whether or not to quote fields. Default: false - column_delimiter : string Which delimiter to use, one of "comma", "tab", or "pipe". Default: comma - compression : string The type of compression to use, if any, one of "none", "zip", or "gzip". Default: gzip - filename_prefix : string A user specified filename prefix for the output file to have. Default: null
code_preview : string
The code that this script will run with arguments inserted.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
post_sql_runs(id)¶ Start a run
Parameters: id : integer
The ID of the sql.
Returns: state : string
The state of this run.
sql_id : integer
The ID of this sql.
id : integer
The ID of this run.
output : list:
A list of the outputs of this script. - output_name : string The name of the output file. - file_id : integer The unique ID of the output file. - path : string The temporary link to download this output file, valid for 36 hours.
is_cancel_requested : boolean
True if run cancel requested, else false.
finished_at : string/time
The time that this run finished.
error : string
The error message for this run, if present.
started_at : string/time
The time the last run started.
-
put_containers(id, required_resources, docker_image_name, docker_command, **kwargs)¶ Edit a container
Parameters: id : integer
The ID for the script.
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares.
docker_image_name : string
The name of the docker image to pull from DockerHub.
docker_command : string
The command to run on the container. Will be run via sh as: [“sh”, “-c”, dockerCommand]
target_project_id : integer, optional
Target project to which script outputs will be added.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
remote_host_credential_id : integer, optional
The id of the database credentials to pass into the environment of the container.
docker_image_tag : string, optional
The tag of the docker image to pull from DockerHub (default: latest).
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
time_zone : string, optional
The time zone of this script.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
repo_http_uri : string, optional
The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
git_credential_id : integer, optional
The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used. Unnecessary if no git repo is specified or the git repo is public.
name : string, optional
The name of the container.
repo_ref : string, optional
The tag or branch of the github repo to clone into the container.
Returns: user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
target_project_id : integer
Target project to which script outputs will be added.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template script.
template_dependents_count : integer
How many other scripts use this one as a template.
remote_host_credential_id : integer
The id of the database credentials to pass into the environment of the container.
docker_image_tag : string
The tag of the docker image to pull from DockerHub (default: latest).
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
repo_http_uri : string
The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
docker_command : string
The command to run on the container. Will be run via sh as: [“sh”, “-c”, dockerCommand]
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g Container)
docker_image_name : string
The name of the docker image to pull from DockerHub.
git_credential_id : integer
The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used. Unnecessary if no git repo is specified or the git repo is public.
name : string
The name of the container.
repo_ref : string
The tag or branch of the github repo to clone into the container.
-
put_containers_archive(id, status)¶ Update the archive status of this object
Parameters: id : integer
The ID of the object.
status : boolean
The desired archived status of the object.
Returns: user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
target_project_id : integer
Target project to which script outputs will be added.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template script.
template_dependents_count : integer
How many other scripts use this one as a template.
remote_host_credential_id : integer
The id of the database credentials to pass into the environment of the container.
docker_image_tag : string
The tag of the docker image to pull from DockerHub (default: latest).
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
repo_http_uri : string
The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
docker_command : string
The command to run on the container. Will be run via sh as: [“sh”, “-c”, dockerCommand]
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g Container)
docker_image_name : string
The name of the docker image to pull from DockerHub.
git_credential_id : integer
The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used. Unnecessary if no git repo is specified or the git repo is public.
name : string
The name of the container.
repo_ref : string
The tag or branch of the github repo to clone into the container.
-
put_containers_projects(id, project_id)¶ Add a container docker to a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Set the permissions groups has on this object
Parameters: id : integer
ID of the resource to be shared
permission_level : string
Options are: “read”, “write”, or “manage”
group_ids : list
An array of one or more group IDs
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
Set the permissions users have on this object
Parameters: id : integer
ID of the resource to be shared
user_ids : list
An array of one or more user IDs
permission_level : string
Options are: “read”, “write”, or “manage”
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
put_custom(id, **kwargs)¶ Replace all attributes of this CustomScript
Parameters: id : integer
The ID for the script.
remote_host_id : integer, optional
The remote host ID that this script will connect to.
target_project_id : integer, optional
Target project to which script outputs will be added.
time_zone : string, optional
The time zone of this script.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
credential_id : integer, optional
The credential that this script will use.
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
name : string, optional
The name of the script.
Returns: state : string
The status of the script’s last run.
target_project_id : integer
Target project to which script outputs will be added.
updated_at : string/time
The time the script was last updated.
from_template_id : integer
The ID of the template script.
credential_id : integer
The credential that this script will use.
code_preview : string
The code that this script will run with arguments inserted.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer
The ID of the parent job that will trigger this script
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
archived : string
The archival status of the requested object(s).
id : integer
The ID for the script.
finished_at : string/time
The time that the script’s last run finished.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
remote_host_id : integer
The remote host ID that this script will connect to.
type : string
The type of the script (e.g Custom)
name : string
The name of the script.
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
-
put_custom_archive(id, status)¶ Update the archive status of this object
Parameters: id : integer
The ID of the object.
status : boolean
The desired archived status of the object.
Returns: state : string
The status of the script’s last run.
target_project_id : integer
Target project to which script outputs will be added.
updated_at : string/time
The time the script was last updated.
from_template_id : integer
The ID of the template script.
credential_id : integer
The credential that this script will use.
code_preview : string
The code that this script will run with arguments inserted.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer
The ID of the parent job that will trigger this script
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
archived : string
The archival status of the requested object(s).
id : integer
The ID for the script.
finished_at : string/time
The time that the script’s last run finished.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
remote_host_id : integer
The remote host ID that this script will connect to.
type : string
The type of the script (e.g Custom)
name : string
The name of the script.
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
-
put_custom_projects(id, project_id)¶ Add a Job to a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Set the permissions groups has on this object
Parameters: id : integer
ID of the resource to be shared
permission_level : string
Options are: “read”, “write”, or “manage”
group_ids : list
An array of one or more group IDs
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
Set the permissions users have on this object
Parameters: id : integer
ID of the resource to be shared
user_ids : list
An array of one or more user IDs
permission_level : string
Options are: “read”, “write”, or “manage”
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
put_javascript(id, source, credential_id, remote_host_id, name, **kwargs)¶ Replace all attributes of this JavaScript Script
Parameters: id : integer
The ID for the script.
source : string
The body/text of the script.
credential_id : integer
The credential that this script will use.
remote_host_id : integer
The remote host ID that this script will connect to.
name : string
The name of the script.
next_run_at : string/time, optional
The time of the next scheduled run.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
time_zone : string, optional
The time zone of this script.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
target_project_id : integer, optional
Target project to which script outputs will be added.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
credential_id : integer
The credential that this script will use.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
remote_host_id : integer
The remote host ID that this script will connect to.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
put_javascript_archive(id, status)¶ Update the archive status of this object
Parameters: id : integer
The ID of the object.
status : boolean
The desired archived status of the object.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
credential_id : integer
The credential that this script will use.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
remote_host_id : integer
The remote host ID that this script will connect to.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
put_javascript_projects(id, project_id)¶ Add a scripted sql to a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Set the permissions groups has on this object
Parameters: id : integer
ID of the resource to be shared
permission_level : string
Options are: “read”, “write”, or “manage”
group_ids : list
An array of one or more group IDs
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
Set the permissions users have on this object
Parameters: id : integer
ID of the resource to be shared
user_ids : list
An array of one or more user IDs
permission_level : string
Options are: “read”, “write”, or “manage”
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
put_python3(id, source, name, **kwargs)¶ Replace all attributes of this Python Script
Parameters: id : integer
The ID for the script.
source : string
The body/text of the script.
name : string
The name of the script.
next_run_at : string/time, optional
The time of the next scheduled run.
required_resources : dict, optional:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
time_zone : string, optional
The time zone of this script.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
target_project_id : integer, optional
Target project to which script outputs will be added.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
put_python3_archive(id, status)¶ Update the archive status of this object
Parameters: id : integer
The ID of the object.
status : boolean
The desired archived status of the object.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
put_python3_projects(id, project_id)¶ Add a python docker to a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Set the permissions groups has on this object
Parameters: id : integer
ID of the resource to be shared
permission_level : string
Options are: “read”, “write”, or “manage”
group_ids : list
An array of one or more group IDs
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
Set the permissions users have on this object
Parameters: id : integer
ID of the resource to be shared
user_ids : list
An array of one or more user IDs
permission_level : string
Options are: “read”, “write”, or “manage”
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
put_r(id, source, name, **kwargs)¶ Replace all attributes of this R Script
Parameters: id : integer
The ID for the script.
source : string
The body/text of the script.
name : string
The name of the script.
next_run_at : string/time, optional
The time of the next scheduled run.
required_resources : dict, optional:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
time_zone : string, optional
The time zone of this script.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
target_project_id : integer, optional
Target project to which script outputs will be added.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
put_r_archive(id, status)¶ Update the archive status of this object
Parameters: id : integer
The ID of the object.
status : boolean
The desired archived status of the object.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
source : string
The body/text of the script.
template_dependents_count : integer
How many other scripts use this one as a template.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
required_resources : dict:
- disk_space : number/float The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. - memory : integer The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. - cpu : integer The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares.
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
put_r_projects(id, project_id)¶ Add a r docker to a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Set the permissions groups has on this object
Parameters: id : integer
ID of the resource to be shared
permission_level : string
Options are: “read”, “write”, or “manage”
group_ids : list
An array of one or more group IDs
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
Set the permissions users have on this object
Parameters: id : integer
ID of the resource to be shared
user_ids : list
An array of one or more user IDs
permission_level : string
Options are: “read”, “write”, or “manage”
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
put_sql(id, sql, credential_id, remote_host_id, name, **kwargs)¶ Replace all attributes of this SQL script
Parameters: id : integer
The ID for the script.
sql : string
The raw SQL query for the script.
credential_id : integer
The credential that this script will use.
remote_host_id : integer
The remote host ID that this script will connect to.
name : string
The name of the script.
next_run_at : string/time, optional
The time of the next scheduled run.
user_context : string, optional
“runner” or “author”, who to execute the script as when run as a template.
csv_settings : dict, optional:
- force_multifile : boolean Whether or not the csv should be split into multiple files. Default: false - include_header : boolean Whether or not to include headers in the output data. Default: true - unquoted : boolean Whether or not to quote fields. Default: false - column_delimiter : string Which delimiter to use, one of "comma", "tab", or "pipe". Default: comma - compression : string The type of compression to use, if any, one of "none", "zip", or "gzip". Default: gzip - filename_prefix : string A user specified filename prefix for the output file to have. Default: null
notifications : dict, optional:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
params : list, optional:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
time_zone : string, optional
The time zone of this script.
schedule : dict, optional:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
parent_id : integer, optional
The ID of the parent job that will trigger this script
arguments : dict, optional
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
target_project_id : integer, optional
Target project to which script outputs will be added.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
credential_id : integer
The credential that this script will use.
remote_host_id : integer
The remote host ID that this script will connect to.
template_dependents_count : integer
How many other scripts use this one as a template.
sql : string
The raw SQL query for the script.
expanded_arguments : dict
Expanded arguments for use in injecting into different environments.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
csv_settings : dict:
- force_multifile : boolean Whether or not the csv should be split into multiple files. Default: false - include_header : boolean Whether or not to include headers in the output data. Default: true - unquoted : boolean Whether or not to quote fields. Default: false - column_delimiter : string Which delimiter to use, one of "comma", "tab", or "pipe". Default: comma - compression : string The type of compression to use, if any, one of "none", "zip", or "gzip". Default: gzip - filename_prefix : string A user specified filename prefix for the output file to have. Default: null
code_preview : string
The code that this script will run with arguments inserted.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
put_sql_archive(id, status)¶ Update the archive status of this object
Parameters: id : integer
The ID of the object.
status : boolean
The desired archived status of the object.
Returns: next_run_at : string/time
The time of the next scheduled run.
user_context : string
“runner” or “author”, who to execute the script as when run as a template.
state : string
The status of the script’s last run.
updated_at : string/time
The time the script was last updated.
is_template : boolean
Whether others scripts use this one as a template.
from_template_id : integer
The ID of the template this script uses, if any.
credential_id : integer
The credential that this script will use.
remote_host_id : integer
The remote host ID that this script will connect to.
template_dependents_count : integer
How many other scripts use this one as a template.
sql : string
The raw SQL query for the script.
expanded_arguments : dict
Expanded arguments for use in injecting into different environments.
running_as : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
params : list:
A definition of the parameters this script accepts in the arguments field. - label : string The label to present to users when asking them for the value. - description : string A short sentence or fragment describing this parameter to the end user. - name : string The variable's name as used within your code. - type : string The type of parameter. Valid options: string, integer, float, bool, file, database, credential_aws, credential_redshift, or credential_custom - default : string If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. - required : boolean Whether this param is required. - value : string The value you would like to set this param to. Setting this value makes this parameter a fixed param.
template_script_name : string
The name of the template script.
time_zone : string
The time zone of this script.
schedule : dict:
- scheduled_runs_per_hour : integer Alternative to scheduled minutes, number of times to run per hour - scheduled_hours : list Hours of the day it is scheduled on - scheduled : boolean If the object is scheduled - scheduled_minutes : list Minutes of the day it is scheduled on - scheduled_days : list Day based on numeric value starting at 0 for Sunday
links : dict:
- details : string The details link to get more information about the script. - runs : string The runs link to get the run information list for this script.
arguments : dict
Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
finished_at : string/time
The time that the script’s last run finished.
archived : string
The archival status of the requested object(s).
parent_id : integer
The ID of the parent job that will trigger this script
id : integer
The ID for the script.
published_as_template_id : integer
The ID of the template that this script is backing.
csv_settings : dict:
- force_multifile : boolean Whether or not the csv should be split into multiple files. Default: false - include_header : boolean Whether or not to include headers in the output data. Default: true - unquoted : boolean Whether or not to quote fields. Default: false - column_delimiter : string Which delimiter to use, one of "comma", "tab", or "pipe". Default: comma - compression : string The type of compression to use, if any, one of "none", "zip", or "gzip". Default: gzip - filename_prefix : string A user specified filename prefix for the output file to have. Default: null
code_preview : string
The code that this script will run with arguments inserted.
notifications : dict:
- stall_warning_minutes : integer Stall warning emails will be sent after this amount of minutes. - failure_email_addresses : list Addresses to notify by e-mail when the job fails. - success_email_body : string Custom body text for success e-mail, written in Markdown. - failure_on : boolean If failure email notifications are on - success_on : boolean If success email notifications are on - success_email_subject : string Custom subject line for success e-mail. - urls : list URLs to receive a POST request at job completion - success_email_addresses : list Addresses to notify by e-mail when the job completes successfully.
author : dict:
- username : string This user's username. - online : boolean Whether this user is online. - initials : string This user's initials. - name : string This user's name. - id : integer The ID of this user.
created_at : string/time
The time this script was created.
hidden : boolean
The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID
projects : list:
A list of projects containing the script. - name : string The name of the project. - id : integer The ID for the project.
type : string
The type of the script (e.g SQL, Container, Python, R, JavaScript)
name : string
The name of the script.
target_project_id : integer
Target project to which script outputs will be added.
-
put_sql_projects(id, project_id)¶ Add a scripts to a project
Parameters: id : integer
ID of the resource
project_id : integer
The ID of the project
Returns: None
Response code 204: success
Set the permissions groups has on this object
Parameters: id : integer
ID of the resource to be shared
permission_level : string
Options are: “read”, “write”, or “manage”
group_ids : list
An array of one or more group IDs
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
Set the permissions users have on this object
Parameters: id : integer
ID of the resource to be shared
user_ids : list
An array of one or more user IDs
permission_level : string
Options are: “read”, “write”, or “manage”
Returns: total_user_shares : integer
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
writers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
total_group_shares : integer
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.
owners : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
readers : dict:
- users : list:: - name : string - id : integer - groups : list:: - name : string - id : integer
-
Tables¶
-
class
Tables(session, return_type='civis')¶ Methods
get(id)Show basic table info get_enhancements_cass_ncoa(id, source_table_id)View the status of a CASS / NCOA table enhancement get_enhancements_geocodings(id, source_table_id)View the status of a geocoding table enhancement get_enhancements_prepared_matchings(id, ...)View a prepared matching enhancement get_enhancements_table_matchings(id, ...)View a table matching enhancement list(**kwargs)List tables list_columns(id, **kwargs)List columns in the specified table patch(id, **kwargs)Update a table post(database_id, data, schema, name)Import a file into a table post_enhancements_cass_ncoa(source_table_id, ...)Standardize addresses in a table post_enhancements_geocodings(source_table_id)Geocode a table post_enhancements_prepared_matchings(...)Match person records against a dynamo table prepared by Civis post_enhancements_table_matchings(...)Match person records against an arbitrary Redshift table post_refresh(id)Request a refresh for column and table statistics -
get(id)¶ Show basic table info
Parameters: id : integer
Returns: size_mb : number/float
The size of the table in megabytes.
schema : string
The name of the schema containing the table.
multipart_key : list
sortkeys : string
The column used as the Amazon Redshift sortkey.
refresh_status : string
How up-to-date the table’s statistics on row counts, null counts, distinct counts, and values distributions are. One of: refreshing, stale, or current.
description : string
The description of the table, as specified by the table owner
columns : list:
- encoding : string The compression encoding for this columnSee: http://docs.aws.amazon.com /redshift/latest/dg/c_Compression_encodings.html - useable_as_primary_key : boolean Whether the column may be used as an primary key to identify table rows. - coverage_count : integer Number of non-null values in the column. - possible_dependent_variable_types : list Possible dependent variable types the column may be used to model. Null if it may not be used as a dependent variable. - max_value : string Largest value in the column. - order : integer Relative position of the column in the table. - sql_type : string SQL type of the column. - min_value : string Smallest value in the column. - sample_values : list A sample of values from the column. - description : string The description of the column, as specified by the table owner - value_distribution_percent : dict A mapping between each value in the column and the percentage of rows with that value.Only present for tables with fewer than approximately 25,000,000 rows and for columns with fewer than twenty distinct values. - avg_value : number/float Average value of the column, where applicable. - value_distribution : dict An object mapping distinct values in the column to the number of times they appear in the column - useable_as_independent_variable : boolean Whether the column may be used as an independent variable to train a model. - stddev : number/float Stddev of the column, where applicable. - distinct_count : integer Number of distinct values in the column. - name : string Name of the column. - null_count : integer Number of null values in the column.
refresh_id : string
The ID of the most recent statistics refresh.
outgoing_table_matches : list:
- target_id : integer Target ID - target_type : string Target type - job : dict:: - state : string Whether the job is idle, queued, running, cancelled, or failed. - updated_at : string/date-time - created_at : string/date-time - id : integer - match_options : dict:: - threshold : string - max_matches : integer - hidden : boolean The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID - type : string - runs : list:: Information about the most recent runs of the job. - state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started. - last_run : dict:: - state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started. - name : string - target : dict:: - name : string - source_table_id : integer Source table
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
database_id : integer
The ID of the database.
row_count : integer
The number of rows in the table.
id : integer
The ID of the table.
enhancements : list:
- type : string - join_id : integer - updated_at : string/time - created_at : string/time
is_view : boolean
True if this table represents a view. False if it represents a regular table.
ontology_mapping : dict
The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys.
owner : string
The database username of the table’s owner.
view_def : string
column_count : integer
The number of columns in the table.
distkey : string
The column used as the Amazon Redshift distkey.
last_refresh : string/date-time
The time of the last statistics refresh.
joins : list:
- left_table_id : integer - on : string - updated_at : string/time - created_at : string/time - right_identifier : string - id : integer - left_identifier : string - right_table_id : integer - left_join : boolean
name : string
Name of the table.
-
get_enhancements_cass_ncoa(id, source_table_id)¶ View the status of a CASS / NCOA table enhancement
Parameters: id : integer
The ID of the enhancement.
source_table_id : integer
The ID of the table that was enhanced.
Returns: output_level : string
The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of ‘cass’ or ‘all.’For NCOA enhancements, one of ‘cass’, ‘ncoa’ , ‘coalesced’ or ‘all’.By default, all fields will be returned.
state : string
The state of the enhancement, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
enhanced_table_name : string
The name of the table created by the enhancement.
enhanced_table_schema : string
The schema name of the table created by the enhancement.
id : integer
The ID of the enhancement.
ncoa_credential_id : integer
Credential to use when performing NCOA updates. Required if ‘performNcoa’ is true.
perform_ncoa : boolean
Whether to update addresses for records matching the National Change of Address (NCOA) database.
source_table_id : integer
The ID of the table that was enhanced.
-
get_enhancements_geocodings(id, source_table_id)¶ View the status of a geocoding table enhancement
Parameters: id : integer
The ID of the enhancement.
source_table_id : integer
The ID of the table that was enhanced.
Returns: state : string
The state of the enhancement, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
source_table_id : integer
The ID of the table that was enhanced.
enhanced_table_name : string
The name of the table created by the enhancement.
enhanced_table_schema : string
The schema name of the table created by the enhancement.
id : integer
The ID of the enhancement.
-
get_enhancements_prepared_matchings(id, source_table_id)¶ View a prepared matching enhancement
Parameters: id : integer
The ID of the enhancement.
source_table_id : integer
The ID of the table that was enhanced.
Returns: match_table_id : integer
The ID of the Dynamo table to match against.
state : string
The state of the enhancement, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
enhanced_table_name : string
The name of the table created by the enhancement.
enhanced_table_schema : string
The schema name of the table created by the enhancement.
id : integer
The ID of the enhancement.
max_matches : integer
The maximum number of individuals a person may be matched with.A value of 0 indicates that all matches should be returned.
threshold : number/float
The confidence threshold which must be met for two individuals to be declared a match. Must be less than or equal to 1 and greater than or equal to 0.
source_table_id : integer
The ID of the table that was enhanced.
-
get_enhancements_table_matchings(id, source_table_id)¶ View a table matching enhancement
Parameters: id : integer
The ID of the enhancement.
source_table_id : integer
The ID of the table that was enhanced.
Returns: match_table_id : integer
The ID of the Redshift table to match against.
state : string
The state of the enhancement, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
enhanced_table_name : string
The name of the table created by the enhancement.
enhanced_table_schema : string
The schema name of the table created by the enhancement.
id : integer
The ID of the enhancement.
max_matches : integer
The maximum number of individuals a person may be matched with.A value of 0 indicates that all matches should be returned.
threshold : number/float
The confidence threshold which must be met for two individuals to be declared a match. Must be less than or equal to 1 and greater than or equal to 0.
source_table_id : integer
The ID of the table that was enhanced.
-
list(**kwargs)¶ List tables
Parameters: database_id : integer, optional
The ID of the database.
schema : string, optional
If specified, will be used to filter the tables returned. Substring matching is supported with “%” and “*” wildcards (e.g., “schema=%census%” will return both “client_census.table” and “census_2010.table”).
name : string, optional
If specified, will be used to filter the tables returned. Substring matching is supported with “%” and “*” wildcards (e.g., “name=%table%” will return both “table1” and “my table”).
search : string, optional
If specified, will be used to filter the tables returned. Will search across schema and name (in the full form schema.name) and will return any full name containing the search string.
limit : integer, optional
Number of results to return. Defaults to 50. Maximum allowed is 1000.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to schema. Must be one of: schema, name, search.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: database_id : integer
The ID of the database.
row_count : integer
The number of rows in the table.
is_view : boolean
True if this table represents a view. False if it represents a regular table.
schema : string
The name of the schema containing the table.
id : integer
The ID of the table.
sortkeys : string
The column used as the Amazon Redshift sortkey.
refresh_status : string
How up-to-date the table’s statistics on row counts, null counts, distinct counts, and values distributions are. One of: refreshing, stale, or current.
size_mb : number/float
The size of the table in megabytes.
column_count : integer
The number of columns in the table.
owner : string
The database username of the table’s owner.
description : string
The description of the table, as specified by the table owner
distkey : string
The column used as the Amazon Redshift distkey.
refresh_id : string
The ID of the most recent statistics refresh.
last_refresh : string/date-time
The time of the last statistics refresh.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
Name of the table.
-
list_columns(id, **kwargs)¶ List columns in the specified table
Parameters: id : integer
name : string, optional
Search for columns with the given name, within the specified table.
limit : integer, optional
Number of results to return. Defaults to its maximum of 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to name. Must be one of: name, order.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: encoding : string
The compression encoding for this columnSee: http://docs.aws.amazon.com/redshift/latest/dg/c_Compression_encodings.html
useable_as_primary_key : boolean
Whether the column may be used as an primary key to identify table rows.
coverage_count : integer
Number of non-null values in the column.
possible_dependent_variable_types : list
Possible dependent variable types the column may be used to model. Null if it may not be used as a dependent variable.
max_value : string
Largest value in the column.
order : integer
Relative position of the column in the table.
sql_type : string
SQL type of the column.
min_value : string
Smallest value in the column.
sample_values : list
A sample of values from the column.
description : string
The description of the column, as specified by the table owner
value_distribution_percent : dict
A mapping between each value in the column and the percentage of rows with that value.Only present for tables with fewer than approximately 25,000,000 rows and for columns with fewer than twenty distinct values.
avg_value : number/float
Average value of the column, where applicable.
value_distribution : dict
An object mapping distinct values in the column to the number of times they appear in the column
useable_as_independent_variable : boolean
Whether the column may be used as an independent variable to train a model.
stddev : number/float
Stddev of the column, where applicable.
distinct_count : integer
Number of distinct values in the column.
name : string
Name of the column.
null_count : integer
Number of null values in the column.
-
patch(id, **kwargs)¶ Update a table
Parameters: id : integer
The ID of the table.
description : string, optional
The user-defined description of the table.
ontology_mapping : dict, optional
The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys.
Returns: database_id : integer
The ID of the database.
row_count : integer
The number of rows in the table.
is_view : boolean
True if this table represents a view. False if it represents a regular table.
schema : string
The name of the schema containing the table.
id : integer
The ID of the table.
sortkeys : string
The column used as the Amazon Redshift sortkey.
refresh_status : string
How up-to-date the table’s statistics on row counts, null counts, distinct counts, and values distributions are. One of: refreshing, stale, or current.
size_mb : number/float
The size of the table in megabytes.
column_count : integer
The number of columns in the table.
owner : string
The database username of the table’s owner.
description : string
The description of the table, as specified by the table owner
distkey : string
The column used as the Amazon Redshift distkey.
refresh_id : string
The ID of the most recent statistics refresh.
ontology_mapping : dict
The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys.
last_refresh : string/date-time
The time of the last statistics refresh.
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
name : string
Name of the table.
-
post(database_id, data, schema, name)¶ Import a file into a table
Parameters: database_id : integer
The ID of the destination database.
data : string
The file to import, uploaded using HTTP multipart.
schema : string
The destination schema name.
name : string
The destination table name, without the schema prefix.
Returns: database_id : integer
The ID of the destination database.
state : string
The state of the last run.
schema : string
The destination schema name.
finished_at : string/date-time
The end time of the last run.
started_at : string/date-time
The start time of the last run.
name : string
The destination table name, without the schema prefix.
-
post_enhancements_cass_ncoa(source_table_id, **kwargs)¶ Standardize addresses in a table
Parameters: source_table_id : integer
The ID of the table to be enhanced.
ncoa_credential_id : integer, optional
Credential to use when performing NCOA updates. Required if ‘performNcoa’ is true.
output_level : string, optional
The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of ‘cass’ or ‘all.’For NCOA enhancements, one of ‘cass’, ‘ncoa’ , ‘coalesced’ or ‘all’.By default, all fields will be returned.
perform_ncoa : boolean, optional
Whether to update addresses for records matching the National Change of Address (NCOA) database.
Returns: output_level : string
The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of ‘cass’ or ‘all.’For NCOA enhancements, one of ‘cass’, ‘ncoa’ , ‘coalesced’ or ‘all’.By default, all fields will be returned.
state : string
The state of the enhancement, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
enhanced_table_name : string
The name of the table created by the enhancement.
enhanced_table_schema : string
The schema name of the table created by the enhancement.
id : integer
The ID of the enhancement.
ncoa_credential_id : integer
Credential to use when performing NCOA updates. Required if ‘performNcoa’ is true.
perform_ncoa : boolean
Whether to update addresses for records matching the National Change of Address (NCOA) database.
source_table_id : integer
The ID of the table that was enhanced.
-
post_enhancements_geocodings(source_table_id)¶ Geocode a table
Parameters: source_table_id : integer
The ID of the table to be enhanced.
Returns: state : string
The state of the enhancement, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
source_table_id : integer
The ID of the table that was enhanced.
enhanced_table_name : string
The name of the table created by the enhancement.
enhanced_table_schema : string
The schema name of the table created by the enhancement.
id : integer
The ID of the enhancement.
-
post_enhancements_prepared_matchings(source_table_id, match_table_id, threshold, **kwargs)¶ Match person records against a dynamo table prepared by Civis
Parameters: source_table_id : integer
The ID of the table to be enhanced.
match_table_id : integer
The ID of the Dynamo table to match against.
threshold : number/float
The confidence threshold which must be met for two individuals to be declared a match. Must be less than or equal to 1 and greater than or equal to 0.
max_matches : integer, optional
The maximum number of individuals a person may be matched with.A value of 0 indicates that all matches should be returned.
Returns: match_table_id : integer
The ID of the Dynamo table to match against.
state : string
The state of the enhancement, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
enhanced_table_name : string
The name of the table created by the enhancement.
enhanced_table_schema : string
The schema name of the table created by the enhancement.
id : integer
The ID of the enhancement.
max_matches : integer
The maximum number of individuals a person may be matched with.A value of 0 indicates that all matches should be returned.
threshold : number/float
The confidence threshold which must be met for two individuals to be declared a match. Must be less than or equal to 1 and greater than or equal to 0.
source_table_id : integer
The ID of the table that was enhanced.
-
post_enhancements_table_matchings(source_table_id, match_table_id, threshold, **kwargs)¶ Match person records against an arbitrary Redshift table
Parameters: source_table_id : integer
The ID of the table to be enhanced.
match_table_id : integer
The ID of the Redshift table to match against.
threshold : number/float
The confidence threshold which must be met for two individuals to be declared a match. Must be less than or equal to 1 and greater than or equal to 0.
max_matches : integer, optional
The maximum number of individuals a person may be matched with.A value of 0 indicates that all matches should be returned.
Returns: match_table_id : integer
The ID of the Redshift table to match against.
state : string
The state of the enhancement, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
enhanced_table_name : string
The name of the table created by the enhancement.
enhanced_table_schema : string
The schema name of the table created by the enhancement.
id : integer
The ID of the enhancement.
max_matches : integer
The maximum number of individuals a person may be matched with.A value of 0 indicates that all matches should be returned.
threshold : number/float
The confidence threshold which must be met for two individuals to be declared a match. Must be less than or equal to 1 and greater than or equal to 0.
source_table_id : integer
The ID of the table that was enhanced.
-
post_refresh(id)¶ Request a refresh for column and table statistics
Parameters: id : integer
Returns: size_mb : number/float
The size of the table in megabytes.
schema : string
The name of the schema containing the table.
multipart_key : list
sortkeys : string
The column used as the Amazon Redshift sortkey.
refresh_status : string
How up-to-date the table’s statistics on row counts, null counts, distinct counts, and values distributions are. One of: refreshing, stale, or current.
description : string
The description of the table, as specified by the table owner
columns : list:
- encoding : string The compression encoding for this columnSee: http://docs.aws.amazon.com /redshift/latest/dg/c_Compression_encodings.html - useable_as_primary_key : boolean Whether the column may be used as an primary key to identify table rows. - coverage_count : integer Number of non-null values in the column. - possible_dependent_variable_types : list Possible dependent variable types the column may be used to model. Null if it may not be used as a dependent variable. - max_value : string Largest value in the column. - order : integer Relative position of the column in the table. - sql_type : string SQL type of the column. - min_value : string Smallest value in the column. - sample_values : list A sample of values from the column. - description : string The description of the column, as specified by the table owner - value_distribution_percent : dict A mapping between each value in the column and the percentage of rows with that value.Only present for tables with fewer than approximately 25,000,000 rows and for columns with fewer than twenty distinct values. - avg_value : number/float Average value of the column, where applicable. - value_distribution : dict An object mapping distinct values in the column to the number of times they appear in the column - useable_as_independent_variable : boolean Whether the column may be used as an independent variable to train a model. - stddev : number/float Stddev of the column, where applicable. - distinct_count : integer Number of distinct values in the column. - name : string Name of the column. - null_count : integer Number of null values in the column.
refresh_id : string
The ID of the most recent statistics refresh.
outgoing_table_matches : list:
- target_id : integer Target ID - target_type : string Target type - job : dict:: - state : string Whether the job is idle, queued, running, cancelled, or failed. - updated_at : string/date-time - created_at : string/date-time - id : integer - match_options : dict:: - threshold : string - max_matches : integer - hidden : boolean The hidden status of the object. Setting this to true hides it from most API endpoints. The object can still be queried directly by ID - type : string - runs : list:: Information about the most recent runs of the job. - state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started. - last_run : dict:: - state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started. - name : string - target : dict:: - name : string - source_table_id : integer Source table
last_run : dict:
- state : string - created_at : string/time The time that the run was queued. - id : integer - error : string The error message for this run, if present. - finished_at : string/time The time that the run completed. - started_at : string/time The time that the run started.
database_id : integer
The ID of the database.
row_count : integer
The number of rows in the table.
id : integer
The ID of the table.
enhancements : list:
- type : string - join_id : integer - updated_at : string/time - created_at : string/time
is_view : boolean
True if this table represents a view. False if it represents a regular table.
ontology_mapping : dict
The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys.
owner : string
The database username of the table’s owner.
view_def : string
column_count : integer
The number of columns in the table.
distkey : string
The column used as the Amazon Redshift distkey.
last_refresh : string/date-time
The time of the last statistics refresh.
joins : list:
- left_table_id : integer - on : string - updated_at : string/time - created_at : string/time - right_identifier : string - id : integer - left_identifier : string - right_table_id : integer - left_join : boolean
name : string
Name of the table.
-
Users¶
-
class
Users(session, return_type='civis')¶ Methods
delete_api_keys(id, key_id)Revoke the specified API key get(id)Show info about a user get_api_keys(id, key_id)Show the specified API key list(**kwargs)List users list_api_keys(id, **kwargs)Show API keys belonging to the specified user list_me()Show info about the logged-in user patch_me(**kwargs)Update info about the logged-in user post_api_keys(id, expires_in, name, **kwargs)Create a new API key belonging to the logged-in user -
delete_api_keys(id, key_id)¶ Revoke the specified API key
Parameters: id : string
The ID of the user or ‘me’.
key_id : integer
The ID of the API key.
Returns: use_count : integer
The number of times the key has been used.
active : boolean
True if the key has neither expired nor been revoked.
scopes : list
The scopes which the key is permissioned on.
last_used_at : string/date-time
The date and time when the key was last used.
created_at : string/date-time
The date and time when the key was created.
id : integer
The ID of the API key.
expires_at : string/date-time
The date and time when the key expired.
constraints : list:
Constraints on the abilities of the created key - delete_allowed : boolean Whether the constraint allows DELETE requests. - constraint_type : string The type of constraint (exact/prefix/regex/verb). - put_allowed : boolean Whether the constraint allows PUT requests. - head_allowed : boolean Whether the constraint allows HEAD requests. - post_allowed : boolean Whether the constraint allows POST requests. - get_allowed : boolean Whether the constraint allows GET requests. - patch_allowed : boolean Whether the constraint allows PATCH requests. - constraint : string The path matcher of the constraint.
expired : boolean
True if the key has expired.
revoked_at : string/date-time
The date and time when the key was revoked.
name : string
The name of the API key.
-
get(id)¶ Show info about a user
Parameters: id : integer
The ID of this user.
Returns: vpn_enabled : string
The availability of vpn for this user.
phone : string
The phone number of this user.
primary_group_id : integer
The ID of the primary group of this user.
state : string
The state of this user.
id : integer
The ID of this user.
city : string
The city of this user.
user : string
The username of this user.
title : string
The title of this user.
prefers_sms_otp : string
The preference for phone authorization of this user
email : string
The email of this user.
groups : list:
An array of all the groups this user is in. - organization_id : integer The organization associated with this group. - name : string The name of this group. - id : integer The ID of this group.
active : string
The account status of this user.
department : string
The deartment of this user.
time_zone : string
The time zone of this user.
initials : string
The initials of this user.
otp_required_for_login : string
The two factor authorization requirement for this user.
github_username : string
The GitHub username of this user.
name : string
The name of this user.
-
get_api_keys(id, key_id)¶ Show the specified API key
Parameters: id : string
The ID of the user or ‘me’.
key_id : integer
The ID of the API key.
Returns: use_count : integer
The number of times the key has been used.
active : boolean
True if the key has neither expired nor been revoked.
scopes : list
The scopes which the key is permissioned on.
last_used_at : string/date-time
The date and time when the key was last used.
created_at : string/date-time
The date and time when the key was created.
id : integer
The ID of the API key.
expires_at : string/date-time
The date and time when the key expired.
constraints : list:
Constraints on the abilities of the created key - delete_allowed : boolean Whether the constraint allows DELETE requests. - constraint_type : string The type of constraint (exact/prefix/regex/verb). - put_allowed : boolean Whether the constraint allows PUT requests. - head_allowed : boolean Whether the constraint allows HEAD requests. - post_allowed : boolean Whether the constraint allows POST requests. - get_allowed : boolean Whether the constraint allows GET requests. - patch_allowed : boolean Whether the constraint allows PATCH requests. - constraint : string The path matcher of the constraint.
expired : boolean
True if the key has expired.
revoked_at : string/date-time
The date and time when the key was revoked.
name : string
The name of the API key.
-
list(**kwargs)¶ List users
Parameters: feature_flag : string, optional
Return users that have a feature flag enabled.
account_status : string, optional
The account status by which to filter users. May be one of “active”, “inactive”, or “all”.
query : string, optional
Return users who match the given query, based on name, user, and email.
group_id : integer, optional
The ID of the group by which to filter users. Cannot be present if organization_id is.
organization_id : integer, optional
The ID of the organization by which to filter users. Cannot be present if group_id is.
limit : integer, optional
Number of results to return. Defaults to 20. Maximum allowed is 10000.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to name. Must be one of: name, user.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: user : string
The username of this user.
current_sign_in_at : string/date-time
The date and time when the user’s current session began.
primary_group_id : integer
The ID of the primary group of this user.
email : string
The email of this user.
groups : list:
An array of all the groups this user is in. - organization_id : integer The organization associated with this group. - name : string The name of this group. - id : integer The ID of this group.
active : string
The account status of this user.
id : integer
The ID of this user.
created_at : string/date-time
The date and time when the user was created.
name : string
The name of this user.
-
list_api_keys(id, **kwargs)¶ Show API keys belonging to the specified user
Parameters: id : string
The ID of the user or ‘me’.
limit : integer, optional
Number of results to return. Defaults to its maximum of 50.
page_num : integer, optional
Page number of the results to return. Defaults to the first page, 1.
order : string, optional
The field on which to order the result set. Defaults to id. Must be one of: id.
order_dir : string, optional
Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iterator : bool, optional
If True, return a generator to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.
Returns: use_count : integer
The number of times the key has been used.
active : boolean
True if the key has neither expired nor been revoked.
scopes : list
The scopes which the key is permissioned on.
last_used_at : string/date-time
The date and time when the key was last used.
created_at : string/date-time
The date and time when the key was created.
id : integer
The ID of the API key.
expires_at : string/date-time
The date and time when the key expired.
constraint_count : integer
The number of constraints on the created key
expired : boolean
True if the key has expired.
revoked_at : string/date-time
The date and time when the key was revoked.
name : string
The name of the API key.
-
list_me()¶ Show info about the logged-in user
Returns: last_checked_announcements : string/date-time
The date and time at which the user last checked their announcements.
id : integer
The ID of this user.
feature_flags : dict
The feature flag settings for this user.
organization_name : string
The name of the organization the user belongs to.
username : string
This user’s username.
initials : string
This user’s initials.
groups : list:
An array of all the groups this user is in. - organization_id : integer The organization associated with this group. - name : string The name of this group. - id : integer The ID of this group.
preferences : dict
This user’s preferences.
roles : list
The roles this user has, listed by slug.
email : string
This user’s email address.
custom_branding : string
The branding of Platform for this user.
name : string
This user’s name.
-
patch_me(**kwargs)¶ Update info about the logged-in user
Parameters: preferences : dict, optional:
- enhancement_index_author_filter : string Author filter for the enhancements index page. - import_index_status_filter : string Status filter for the imports index page. - script_index_order_dir : string Order direction for the scripts index page. - import_index_archived_filter : string Archived filter for the imports index page. - enhancement_index_archived_filter : string Archived filter for the enhancements index page. - project_index_order_field : string Order field for the projects index page. - model_index_author_filter : string Author filter for the models index page. - script_index_type_filter : string Type filter for the scripts index page. - enhancement_index_order_dir : string Order direction for the enhancements index page. - result_index_type_filter : string Type filter for the results index page. - import_index_order_field : string Order field for the imports index page. - export_index_order_field : string Order field for the exports index page. - project_detail_order_dir : string Order direction for projects detail pages. - import_index_type_filter : string Type filter for the imports index page. - model_index_order_dir : string Order direction for the models index page. - model_index_status_filter : string Status filter for the models index page. - import_index_dest_filter : string Destination filter for the imports index page. - script_index_status_filter : string Status filter for the scripts index page. - script_index_order_field : string Order field for the scripts index page. - import_index_order_dir : string Order direction for the imports index page. - preferred_server_id : integer ID of preferred server. - project_index_author_filter : string Author filter for the projects index page. - export_index_status_filter : string Status filter for the exports index page. - result_index_author_filter : string Author filter for the results index page. - result_index_order_dir : string Order direction for the results index page. - app_index_order_dir : string Oder direction for the apps index pages. - project_detail_author_filter : string Author filter for projects detail pages. - model_index_archived_filter : string Archived filter for the models index page. - export_index_order_dir : string Order direction for the exports index page. - enhancement_index_order_field : string Order field for the enhancements index page. - report_index_thumbnail_view : string Thumbnail view for the reports index page. - project_index_order_dir : string Order direction for the projects index page. - model_index_thumbnail_view : string Thumbnail view for the models index page. - result_index_order_field : string Order field for the results index page. - export_index_author_filter : string Author filter for the exports index page. - script_index_author_filter : string Author filter for the scripts index page. - import_index_author_filter : string Author filter for the imports index page. - export_index_type_filter : string Type filter for the exports index page. - project_index_archived_filter : string Archived filter for the projects index page. - project_detail_order_field : string Order field for projects detail pages. - script_index_archived_filter : string Archived filter for the scripts index page. - result_index_archived_filter : string Archived filter for the results index page. - project_detail_archived_filter : string Arhived filter for the projects detail pages. - model_index_order_field : string Order field for the models index page. - project_detail_type_filter : string Type filter for projects detail pages. - civis_explore_skip_intro : boolean Whether the user is shown steps for each exploration. - app_index_order_field : string Order field for the apps index pages.
last_checked_announcements : string/date-time, optional
The date and time at which the user last checked their announcements.
Returns: last_checked_announcements : string/date-time
The date and time at which the user last checked their announcements.
id : integer
The ID of this user.
feature_flags : dict
The feature flag settings for this user.
organization_name : string
The name of the organization the user belongs to.
username : string
This user’s username.
initials : string
This user’s initials.
groups : list:
An array of all the groups this user is in. - organization_id : integer The organization associated with this group. - name : string The name of this group. - id : integer The ID of this group.
preferences : dict
This user’s preferences.
roles : list
The roles this user has, listed by slug.
email : string
This user’s email address.
custom_branding : string
The branding of Platform for this user.
name : string
This user’s name.
-
post_api_keys(id, expires_in, name, **kwargs)¶ Create a new API key belonging to the logged-in user
Parameters: id : string
The ID of the user or ‘me’.
expires_in : integer
The number of seconds the key should last for.
name : string
The name of the API key.
constraints : list, optional:
Constraints on the abilities of the created key. - delete_allowed : boolean Whether the constraint allows DELETE requests. - constraint_type : string The type of constraint (exact/prefix/regex/verb). - put_allowed : boolean Whether the constraint allows PUT requests. - head_allowed : boolean Whether the constraint allows HEAD requests. - post_allowed : boolean Whether the constraint allows POST requests. - get_allowed : boolean Whether the constraint allows GET requests. - patch_allowed : boolean Whether the constraint allows PATCH requests. - constraint : string The path matcher of the constraint.
Returns: token : string
The API key.
active : boolean
True if the key has neither expired nor been revoked.
id : integer
The ID of the API key.
expires_at : string/date-time
The date and time when the key expired.
created_at : string/date-time
The date and time when the key was created.
constraints : list:
Constraints on the abilities of the created key - delete_allowed : boolean Whether the constraint allows DELETE requests. - constraint_type : string The type of constraint (exact/prefix/regex/verb). - put_allowed : boolean Whether the constraint allows PUT requests. - head_allowed : boolean Whether the constraint allows HEAD requests. - post_allowed : boolean Whether the constraint allows POST requests. - get_allowed : boolean Whether the constraint allows GET requests. - patch_allowed : boolean Whether the constraint allows PATCH requests. - constraint : string The path matcher of the constraint.
expired : boolean
True if the key has expired.
revoked_at : string/date-time
The date and time when the key was revoked.
scopes : list
The scopes which the key is permissioned on.
use_count : integer
The number of times the key has been used.
name : string
The name of the API key.
last_used_at : string/date-time
The date and time when the key was last used.
-
Command Line Interface¶
A command line interface (CLI) to Civis is provided. This can be invoked by
typing the command civis in the shell (sh, bash, zsh, etc.). It can also
be used in Civis container scripts where the Docker image has this client
installed. Here’s a simple example of printing the types of scripts.
> civis scripts list-types
- name: sql
- name: python3
- name: javascript
- name: r
- name: containers
Not all API endpoints are available through the CLI since some take complex data types (e.g., arrays, objects/dictionaries) as input. However, functionality is available for getting information about scripts, logs, etc., as well as executing already created scripts.
There are a few extra, CLI-only commands that wrap the Files API
endpoints to make uploading and downloading files easier:
civis files upload $PATH and civis files download $FILEID $PATH.
The default output format is YAML, but the --json-output allows you to
get output in JSON.