Delete an announcement | admin_delete_announcements |
Get a particular announcement | admin_get_announcements |
List announcements | admin_list_announcements |
List organizations | admin_list_organizations |
Edit an announcement | admin_patch_announcements |
Edit a theme | admin_patch_themes |
Post an announcement | admin_post_announcements |
Create a theme | admin_post_themes |
Delete an alias | aliases_delete |
Revoke the permissions a group has on this object | aliases_delete_shares_groups |
Revoke the permissions a user has on this object | aliases_delete_shares_users |
Get an Alias | aliases_get |
Get details about an alias within an FCO type | aliases_get_object_type |
List Aliases | aliases_list |
List users and groups permissioned on this object | aliases_list_shares |
Update some attributes of this Alias | aliases_patch |
Create an Alias | aliases_post |
Replace all attributes of this Alias | aliases_put |
Set the permissions groups has on this object | aliases_put_shares_groups |
Set the permissions users have on this object | aliases_put_shares_users |
List announcements | announcements_list |
Remove an App Instance from a project | apps_delete_instances_projects |
Revoke the permissions a group has on this object | apps_delete_instances_shares_groups |
Revoke the permissions a user has on this object | apps_delete_instances_shares_users |
Revoke the permissions a group has on this object | apps_delete_releases_shares_groups |
Revoke the permissions a user has on this object | apps_delete_releases_shares_users |
List details of a Decision Application | apps_get |
Return a given app instance | apps_get_instances |
Return a given app release | apps_get_releases |
List apps | apps_list |
List the instances of a Decision Application | apps_list_instances |
List the projects an App Instance belongs to | apps_list_instances_projects |
List users and groups permissioned on this object | apps_list_instances_shares |
List the releases of a particular Decision Application | apps_list_releases |
List users and groups permissioned on this object | apps_list_releases_shares |
Update a given app instance | apps_patch_instances |
Update an existing Decision Application release | apps_patch_releases |
Create a new instance of an application of the given slug | apps_post_instances |
Create a new Decision Application release | apps_post_releases |
Update the Decision Application features for a given organization | apps_put_features |
Update the archive status of this object | apps_put_instances_archive |
Add an App Instance to a project | apps_put_instances_projects |
Set the permissions groups has on this object | apps_put_instances_shares_groups |
Set the permissions users have on this object | apps_put_instances_shares_users |
Update the archive status of this object | apps_put_releases_archive |
Set the permissions groups has on this object | apps_put_releases_shares_groups |
Set the permissions users have on this object | apps_put_releases_shares_users |
Call a function repeatedly until a status is reached. | await await_all |
Cancel the evaluation of a CivisFuture. | cancel |
A file in the Civis Platform | civis_file |
A manifest file in the Civis Platform | civis_file_manifest |
Interface for modeling in the Civis Platform | civis_ml civis_ml_fetch_existing predict.civis_ml |
List of classification models. | CIVIS_ML_CLASSIFIERS |
CivisML Extra Trees Classifier | civis_ml_extra_trees_classifier |
CivisML Extra Trees Regressor | civis_ml_extra_trees_regressor |
CivisML Gradient Boosting Classifier | civis_ml_gradient_boosting_classifier |
CivisML Gradient Boosting Regressor | civis_ml_gradient_boosting_regressor |
CivisML Random Forest Classifier | civis_ml_random_forest_classifier |
CivisML Random Forest Regressor | civis_ml_random_forest_regressor |
List of civis_ml regression models. | CIVIS_ML_REGRESSORS |
CivisML Sparse Linear Regression | civis_ml_sparse_linear_regressor |
CivisML Sparse Logistic | civis_ml_sparse_logistic |
CivisML Sparse Ridge Regression | civis_ml_sparse_ridge_regressor |
Evaluate an expression in Civis Platform | civis_platform |
Civis Script | civis_script |
A table in the Civis Platform | civis_table |
Split a Redshift table into multiple CSV parts on S3 | civis_to_multifile_csv |
Evaluate an expression in Civis Platform | cancel.CivisFuture CivisFuture fetch_logs.CivisFuture resolved.CivisFuture result.CivisFuture run.CivisFuture |
Delete a Cluster Partition | clusters_delete_kubernetes_partitions |
Describe a Kubernetes Cluster | clusters_get_kubernetes |
Describe an Instance Config | clusters_get_kubernetes_instance_configs |
Describe a Cluster Partition | clusters_get_kubernetes_partitions |
List Kubernetes Clusters | clusters_list_kubernetes |
Get stats about deployments associated with a Kubernetes Cluster | clusters_list_kubernetes_deployment_stats |
List the deployments associated with a Kubernetes Cluster | clusters_list_kubernetes_deployments |
Get graphs of historical resource usage in an Instance Config | clusters_list_kubernetes_instance_configs_historical_graphs |
Get statistics about the current users of an Instance Config | clusters_list_kubernetes_instance_configs_user_statistics |
List Cluster Partitions for given cluster | clusters_list_kubernetes_partitions |
Update a Kubernetes Cluster | clusters_patch_kubernetes |
Update a Cluster Partition | clusters_patch_kubernetes_partitions |
Create a Kubernetes Cluster | clusters_post_kubernetes |
Create a Cluster Partition for given cluster | clusters_post_kubernetes_partitions |
Get civis_ml model coefficients | coef.civis_ml |
Revoke the permissions a group has on this object | credentials_delete_shares_groups |
Revoke the permissions a user has on this object | credentials_delete_shares_users |
Get a credential | credentials_get |
List credentials | credentials_list |
List users and groups permissioned on this object | credentials_list_shares |
Create a credential | credentials_post |
Authenticate against a remote host | credentials_post_authenticate |
Generate a temporary credential for accessing S3 | credentials_post_temporary |
Update an existing credential | credentials_put |
Set the permissions groups has on this object | credentials_put_shares_groups |
Set the permissions users have on this object | credentials_put_shares_users |
Remove a whitelisted IP address | databases_delete_whitelist_ips |
Show database information | databases_get |
View details about a whitelisted IP | databases_get_whitelist_ips |
List databases | databases_list |
Get the advanced settings for this database | databases_list_advanced_settings |
List schemas in this database | databases_list_schemas |
List tables in the specified database, deprecated use "GET /tables" instead | databases_list_tables |
List tables in the specified database, deprecated use "GET /tables" instead | databases_list_tables_search |
List whitelisted IPs for the specified database | databases_list_whitelist_ips |
Update the advanced settings for this database | databases_patch_advanced_settings |
Creates and enqueues a schema scanner job | databases_post_schemas_scan |
Whitelist an IP address | databases_post_whitelist_ips |
Edit the advanced settings for this database | databases_put_advanced_settings |
The current user's default credential. | default_credential |
Download a table or a file from the Civis Platform to local disk | download_civis download_civis.character download_civis.numeric download_civis.sql |
List API endpoints | endpoints_list |
Remove a CASS/NCOA Enhancement from a project | enhancements_delete_cass_ncoa_projects |
Cancel a run | enhancements_delete_cass_ncoa_runs |
Revoke the permissions a group has on this object | enhancements_delete_cass_ncoa_shares_groups |
Revoke the permissions a user has on this object | enhancements_delete_cass_ncoa_shares_users |
Remove a Civis Data Match Enhancement from a project | enhancements_delete_civis_data_match_projects |
Cancel a run | enhancements_delete_civis_data_match_runs |
Revoke the permissions a group has on this object | enhancements_delete_civis_data_match_shares_groups |
Revoke the permissions a user has on this object | enhancements_delete_civis_data_match_shares_users |
Remove a Geocode Enhancement from a project | enhancements_delete_geocode_projects |
Cancel a run | enhancements_delete_geocode_runs |
Revoke the permissions a group has on this object | enhancements_delete_geocode_shares_groups |
Revoke the permissions a user has on this object | enhancements_delete_geocode_shares_users |
Get a CASS/NCOA Enhancement | enhancements_get_cass_ncoa |
Check status of a run | enhancements_get_cass_ncoa_runs |
Get a Civis Data Match Enhancement | enhancements_get_civis_data_match |
Check status of a run | enhancements_get_civis_data_match_runs |
Get a Geocode Enhancement | enhancements_get_geocode |
Check status of a run | enhancements_get_geocode_runs |
List Enhancements | enhancements_list |
List the projects a CASS/NCOA Enhancement belongs to | enhancements_list_cass_ncoa_projects |
List runs for the given cass_ncoa | enhancements_list_cass_ncoa_runs |
Get the logs for a run | enhancements_list_cass_ncoa_runs_logs |
List the outputs for a run | enhancements_list_cass_ncoa_runs_outputs |
List users and groups permissioned on this object | enhancements_list_cass_ncoa_shares |
List the projects a Civis Data Match Enhancement belongs to | enhancements_list_civis_data_match_projects |
List runs for the given civis_data_match | enhancements_list_civis_data_match_runs |
Get the logs for a run | enhancements_list_civis_data_match_runs_logs |
List the outputs for a run | enhancements_list_civis_data_match_runs_outputs |
List users and groups permissioned on this object | enhancements_list_civis_data_match_shares |
List the fields in a field mapping for Civis Data Match, Data Unification, and Table Deduplication jobs | enhancements_list_field_mapping |
List the projects a Geocode Enhancement belongs to | enhancements_list_geocode_projects |
List runs for the given geocode | enhancements_list_geocode_runs |
Get the logs for a run | enhancements_list_geocode_runs_logs |
List the outputs for a run | enhancements_list_geocode_runs_outputs |
List users and groups permissioned on this object | enhancements_list_geocode_shares |
List available enhancement types | enhancements_list_types |
Update some attributes of this CASS/NCOA Enhancement | enhancements_patch_cass_ncoa |
Update some attributes of this Civis Data Match Enhancement | enhancements_patch_civis_data_match |
Update some attributes of this Geocode Enhancement | enhancements_patch_geocode |
Create a CASS/NCOA Enhancement | enhancements_post_cass_ncoa |
Cancel a run | enhancements_post_cass_ncoa_cancel |
Start a run | enhancements_post_cass_ncoa_runs |
Create a Civis Data Match Enhancement | enhancements_post_civis_data_match |
Cancel a run | enhancements_post_civis_data_match_cancel |
Clone this Civis Data Match Enhancement | enhancements_post_civis_data_match_clone |
Start a run | enhancements_post_civis_data_match_runs |
Create a Geocode Enhancement | enhancements_post_geocode |
Cancel a run | enhancements_post_geocode_cancel |
Start a run | enhancements_post_geocode_runs |
Replace all attributes of this CASS/NCOA Enhancement | enhancements_put_cass_ncoa |
Update the archive status of this object | enhancements_put_cass_ncoa_archive |
Add a CASS/NCOA Enhancement to a project | enhancements_put_cass_ncoa_projects |
Set the permissions groups has on this object | enhancements_put_cass_ncoa_shares_groups |
Set the permissions users have on this object | enhancements_put_cass_ncoa_shares_users |
Replace all attributes of this Civis Data Match Enhancement | enhancements_put_civis_data_match |
Update the archive status of this object | enhancements_put_civis_data_match_archive |
Add a Civis Data Match Enhancement to a project | enhancements_put_civis_data_match_projects |
Set the permissions groups has on this object | enhancements_put_civis_data_match_shares_groups |
Set the permissions users have on this object | enhancements_put_civis_data_match_shares_users |
Replace all attributes of this Geocode Enhancement | enhancements_put_geocode |
Update the archive status of this object | enhancements_put_geocode_archive |
Add a Geocode Enhancement to a project | enhancements_put_geocode_projects |
Set the permissions groups has on this object | enhancements_put_geocode_shares_groups |
Set the permissions users have on this object | enhancements_put_geocode_shares_users |
Get a CSV Export | exports_get_files_csv |
List | exports_list |
Update some attributes of this CSV Export | exports_patch_files_csv |
Create a CSV Export | exports_post_files_csv |
Replace all attributes of this CSV Export | exports_put_files_csv |
Update the archive status of this object | exports_put_files_csv_archive |
Deactivate a feature for a group | feature_flags_delete_groups |
Deactivate a feature for a user | feature_flags_delete_users |
Show a feature flag | feature_flags_get |
List feature flags | feature_flags_list |
Activate a feature for a group | feature_flags_put_groups |
Activate a feature for a user | feature_flags_put_users |
Retrieve all results from a paginated endpoint | fetch_all |
Fetches and generates the client in generated_client.R | fetch_and_generate_client |
Fetch job logs from the Civis Platform | fetch_logs |
Retrieve out of sample/fold predictions | fetch_oos_scores |
Return output from a civis_script. | fetch_output fetch_output_file_ids |
Retrieve predictions from a CivisML prediction job | fetch_predictions |
Retrieve some results from a paginated endpoint | fetch_until |
Archive a Preprocess CSV (deprecated, use archiving endpoints instead) | files_delete_preprocess_csv |
Remove a File from a project | files_delete_projects |
Revoke the permissions a group has on this object | files_delete_shares_groups |
Revoke the permissions a user has on this object | files_delete_shares_users |
Get details about a file | files_get |
Get a Preprocess CSV | files_get_preprocess_csv |
List the projects a File belongs to | files_list_projects |
List users and groups permissioned on this object | files_list_shares |
Update details about a file | files_patch |
Update some attributes of this Preprocess CSV | files_patch_preprocess_csv |
Initiate an upload of a file into the platform | files_post |
Initiate a multipart upload | files_post_multipart |
Complete a multipart upload | files_post_multipart_complete |
Create a Preprocess CSV | files_post_preprocess_csv |
Update details about a file | files_put |
Replace all attributes of this Preprocess CSV | files_put_preprocess_csv |
Update the archive status of this object | files_put_preprocess_csv_archive |
Add a File to a project | files_put_projects |
Set the permissions groups has on this object | files_put_shares_groups |
Set the permissions users have on this object | files_put_shares_users |
Generate a client | generate_client |
Return the database id for a given database name | get_database_id |
Get error data from civis_errors | get_error |
Get model feature importance | get_feature_importance |
Derive the job type and version from the given alias. | get_job_type_version |
Get model metrics | get_metric |
Get a script function matching a job type. | get_script_fun |
Get the status from results of 'await' | get_status |
Return the table id for a given table | get_table_id |
Get template IDs for all accessible CivisML versions. | get_template_ids_all_versions |
Get training template IDs for the specified CivisML version | get_train_template_id |
Remove the bookmark on a git repository | git_repos_delete |
Get a bookmarked git repository | git_repos_get |
List bookmarked git repositories | git_repos_list |
Bookmark a git repository | git_repos_post |
Delete a Group (deprecated) | groups_delete |
Remove a user from a group | groups_delete_members |
Revoke the permissions a group has on this object | groups_delete_shares_groups |
Revoke the permissions a user has on this object | groups_delete_shares_users |
Get a Group | groups_get |
List Groups | groups_list |
List users and groups permissioned on this object | groups_list_shares |
Update some attributes of this Group | groups_patch |
Create a Group | groups_post |
Replace all attributes of this Group | groups_put |
Add a user to a group | groups_put_members |
Set the permissions groups has on this object | groups_put_shares_groups |
Set the permissions users have on this object | groups_put_shares_users |
Plot a histogram of the predicted scores or probabilities for a CivisML object | hist.civis_ml |
Archive a CSV Import (deprecated, use archiving endpoints instead) | imports_delete_files_csv |
Cancel a run | imports_delete_files_runs |
Remove an Import from a project | imports_delete_projects |
Revoke the permissions a group has on this object | imports_delete_shares_groups |
Revoke the permissions a user has on this object | imports_delete_shares_users |
Archive a sync (deprecated, use the /archive endpoint instead) | imports_delete_syncs |
Get details about an import | imports_get |
Get details about a batch import | imports_get_batches |
Get a CSV Import | imports_get_files_csv |
Check status of a run | imports_get_files_runs |
List Imports | imports_list |
List batch imports | imports_list_batches |
List runs for the given import | imports_list_files_runs |
Get the logs for a run | imports_list_files_runs_logs |
List the projects an Import belongs to | imports_list_projects |
Get the run history of this import | imports_list_runs |
Get the logs for a run | imports_list_runs_logs |
List users and groups permissioned on this object | imports_list_shares |
Update some attributes of this CSV Import | imports_patch_files_csv |
Create a new import configuration | imports_post |
Upload multiple files to Civis | imports_post_batches |
Cancel a run | imports_post_cancel |
Initate an import of a tabular file into the platform | imports_post_files |
Create a CSV Import | imports_post_files_csv |
Start a run | imports_post_files_runs |
Run an import | imports_post_runs |
Create a sync | imports_post_syncs |
Update an import | imports_put |
Update the archive status of this object | imports_put_archive |
Replace all attributes of this CSV Import | imports_put_files_csv |
Update the archive status of this object | imports_put_files_csv_archive |
Add an Import to a project | imports_put_projects |
Set the permissions groups has on this object | imports_put_shares_groups |
Set the permissions users have on this object | imports_put_shares_users |
Update a sync | imports_put_syncs |
Update the archive status of this sync | imports_put_syncs_archive |
Remove a Job from a project | jobs_delete_projects |
Cancel a run | jobs_delete_runs |
Revoke the permissions a group has on this object | jobs_delete_shares_groups |
Revoke the permissions a user has on this object | jobs_delete_shares_users |
Show basic job info | jobs_get |
Check status of a job | jobs_get_runs |
List Jobs | jobs_list |
Show nested tree of children that this job triggers | jobs_list_children |
Show chain of parents as a list that this job triggers from | jobs_list_parents |
List the projects a Job belongs to | jobs_list_projects |
List runs for the given job | jobs_list_runs |
Get the logs for a run | jobs_list_runs_logs |
List the outputs for a run | jobs_list_runs_outputs |
List users and groups permissioned on this object | jobs_list_shares |
List the workflows a job belongs to | jobs_list_workflows |
Run a job | jobs_post_runs |
Generate and retrieve trigger email address | jobs_post_trigger_email |
Update the archive status of this object | jobs_put_archive |
Add a Job to a project | jobs_put_projects |
Set the permissions groups has on this object | jobs_put_shares_groups |
Set the permissions users have on this object | jobs_put_shares_users |
Revoke the permissions a group has on this object | json_values_delete_shares_groups |
Revoke the permissions a user has on this object | json_values_delete_shares_users |
Get details about a JSON Value | json_values_get |
List users and groups permissioned on this object | json_values_list_shares |
Update some attributes of this JSON Value | json_values_patch |
Create a JSON Value | json_values_post |
Set the permissions groups has on this object | json_values_put_shares_groups |
Set the permissions users have on this object | json_values_put_shares_users |
Revoke the permissions a group has on this object | match_targets_delete_shares_groups |
Revoke the permissions a user has on this object | match_targets_delete_shares_users |
Show Match Target info | match_targets_get |
List match targets | match_targets_list |
List users and groups permissioned on this object | match_targets_list_shares |
Update a match target | match_targets_patch |
Create a new match target | match_targets_post |
Update the archive status of this object | match_targets_put_archive |
Set the permissions groups has on this object | match_targets_put_shares_groups |
Set the permissions users have on this object | match_targets_put_shares_users |
Cancel a run | media_delete_optimizations_runs |
Revoke the permissions a group has on this object | media_delete_optimizations_shares_groups |
Revoke the permissions a user has on this object | media_delete_optimizations_shares_users |
Revoke the permissions a group has on this object | media_delete_ratecards_shares_groups |
Revoke the permissions a user has on this object | media_delete_ratecards_shares_users |
Revoke the permissions a group has on this object | media_delete_spot_orders_shares_groups |
Revoke the permissions a user has on this object | media_delete_spot_orders_shares_users |
Show a single optimization | media_get_optimizations |
Check status of a run | media_get_optimizations_runs |
Get a Ratecard | media_get_ratecards |
Show a single spot order | media_get_spot_orders |
List all Designated Market Areas | media_list_dmas |
List all optimizations | media_list_optimizations |
List runs for the given optimization | media_list_optimizations_runs |
Get the logs for a run | media_list_optimizations_runs_logs |
List users and groups permissioned on this object | media_list_optimizations_shares |
List all ratecards | media_list_ratecards |
List users and groups permissioned on this object | media_list_ratecards_shares |
List all spot orders | media_list_spot_orders |
List users and groups permissioned on this object | media_list_spot_orders_shares |
List all Media Targets | media_list_targets |
Edit an existing optimization | media_patch_optimizations |
Update some attributes of this Ratecard | media_patch_ratecards |
Create a new optimization | media_post_optimizations |
Clone an existing optimization | media_post_optimizations_clone |
Start a run | media_post_optimizations_runs |
Create a Ratecard | media_post_ratecards |
Create a spot order | media_post_spot_orders |
Update the archive status of this object | media_put_optimizations_archive |
Set the permissions groups has on this object | media_put_optimizations_shares_groups |
Set the permissions users have on this object | media_put_optimizations_shares_users |
Replace all attributes of this Ratecard | media_put_ratecards |
Update the archive status of this object | media_put_ratecards_archive |
Set the permissions groups has on this object | media_put_ratecards_shares_groups |
Set the permissions users have on this object | media_put_ratecards_shares_users |
Edit the specified spot order | media_put_spot_orders |
Update the archive status of this object | media_put_spot_orders_archive |
Set the permissions groups has on this object | media_put_spot_orders_shares_groups |
Set the permissions users have on this object | media_put_spot_orders_shares_users |
Cancel a build | models_delete_builds |
Remove a Model from a project | models_delete_projects |
Revoke the permissions a group has on this object | models_delete_shares_groups |
Revoke the permissions a user has on this object | models_delete_shares_users |
Retrieve model configuration | models_get |
Check status of a build | models_get_builds |
List | models_list |
List builds for the given model | models_list_builds |
Get the logs for a build | models_list_builds_logs |
List the projects a Model belongs to | models_list_projects |
Show the model build schedule | models_list_schedules |
List users and groups permissioned on this object | models_list_shares |
List all available model types | models_list_types |
Update the archive status of this object | models_put_archive |
Add a Model to a project | models_put_projects |
Set the permissions groups has on this object | models_put_shares_groups |
Set the permissions users have on this object | models_put_shares_users |
Upload to files endpoint in parts. | multipart_upload |
Archive a Notebook (deprecated, use archiving endpoints instead) | notebooks_delete |
Delete a Notebook deployment | notebooks_delete_deployments |
Remove a Notebook from a project | notebooks_delete_projects |
Revoke the permissions a group has on this object | notebooks_delete_shares_groups |
Revoke the permissions a user has on this object | notebooks_delete_shares_users |
Get a Notebook | notebooks_get |
Get details about a Notebook deployment | notebooks_get_deployments |
Get file contents at commit_hash | notebooks_get_git_commits |
List Notebooks | notebooks_list |
List deployments for a Notebook | notebooks_list_deployments |
Get the logs for a Notebook deployment | notebooks_list_deployments_logs |
Get the git metadata attached to an item | notebooks_list_git |
Get the git commits for an item | notebooks_list_git_commits |
List the projects a Notebook belongs to | notebooks_list_projects |
List users and groups permissioned on this object | notebooks_list_shares |
Get URLs to update notebook | notebooks_list_update_links |
Update some attributes of this Notebook | notebooks_patch |
Create a Notebook | notebooks_post |
Clone this Notebook | notebooks_post_clone |
Deploy a Notebook | notebooks_post_deployments |
Commit and push a new version of the file | notebooks_post_git_commits |
Replace all attributes of this Notebook | notebooks_put |
Update the archive status of this object | notebooks_put_archive |
Attach an item to a file in a git repo | notebooks_put_git |
Add a Notebook to a project | notebooks_put_projects |
Set the permissions groups has on this object | notebooks_put_shares_groups |
Set the permissions users have on this object | notebooks_put_shares_users |
Receive a stream of notifications as they come in | notifications_list |
List the ontology of column names Civis uses | ontology_list |
Decile plot for classification with civis_ml | plot.civis_ml_classifier |
Y-yhat plot for regression with civis_ml | plot.civis_ml_regressor |
Show the specified prediction | predictions_get |
List predictions | predictions_list |
Show the prediction schedule | predictions_list_schedules |
Print results from a Civis API call | print.civis_api |
Archive a project (deprecated, use the /archive endpoint instead) | projects_delete |
Remove an item from a Parent Project | projects_delete_parent_projects |
Revoke the permissions a group has on this object | projects_delete_shares_groups |
Revoke the permissions a user has on this object | projects_delete_shares_users |
Get a detailed view of a project and the objects in it | projects_get |
List projects | projects_list |
List the Parent Projects an item belongs to | projects_list_parent_projects |
List users and groups permissioned on this object | projects_list_shares |
Create a project | projects_post |
Update a project | projects_put |
Update the archive status of this object | projects_put_archive |
Add an item to a Parent Project | projects_put_parent_projects |
Set the permissions groups has on this object | projects_put_shares_groups |
Set the permissions users have on this object | projects_put_shares_users |
Add in to Publish an R Markdown file to Platform Reports from RStudio | publish_addin |
Publish HTML to Platform Reports | publish_html |
Publish an R Markdown file to Platform Reports | publish_rmd |
Cancel a run | queries_delete_runs |
Get details about a query | queries_get |
Check status of a run | queries_get_runs |
List | queries_list |
List runs for the given query | queries_list_runs |
Get the logs for a run | queries_list_runs_logs |
Execute a query | queries_post |
Start a run | queries_post_runs |
Update the query's associated script | queries_put_scripts |
Run a Query on Platform | query_civis query_civis.character query_civis.numeric query_civis.sql |
Export results from a query to S3 and return a file id. | query_civis_file query_civis_file.character query_civis_file.numeric query_civis_file.sql |
Read tables and files from Civis Platform | read_civis read_civis.character read_civis.civis_script read_civis.numeric read_civis.sql |
Refresh a table | refresh_table |
List the remote hosts | remote_hosts_list |
List data sets available from a remote host | remote_hosts_list_data_sets |
Create a new remote host | remote_hosts_post |
Authenticate against a remote host using either a credential or a user name and password | remote_hosts_post_authenticate |
Revoke permission for this report to perform Civis platform API operations on your behalf | reports_delete_grants |
Remove a Report from a project | reports_delete_projects |
Remove a Service Report from a project | reports_delete_services_projects |
Revoke the permissions a group has on this object | reports_delete_services_shares_groups |
Revoke the permissions a user has on this object | reports_delete_services_shares_users |
Revoke the permissions a group has on this object | reports_delete_shares_groups |
Revoke the permissions a user has on this object | reports_delete_shares_users |
Show a single report | reports_get |
Get file contents at commit_hash | reports_get_git_commits |
Show a single service report | reports_get_services |
List Reports | reports_list |
Get the git metadata attached to an item | reports_list_git |
Get the git commits for an item | reports_list_git_commits |
List the projects a Report belongs to | reports_list_projects |
List the projects a Service Report belongs to | reports_list_services_projects |
List users and groups permissioned on this object | reports_list_services_shares |
List users and groups permissioned on this object | reports_list_shares |
Update a report | reports_patch |
Update some attributes of this service report | reports_patch_services |
Create a report | reports_post |
Commit and push a new version of the file | reports_post_git_commits |
Grant this report the ability to perform Civis platform API operations on your behalf | reports_post_grants |
Refresh the data in this Tableau report | reports_post_refresh |
Create a service report | reports_post_services |
Update the archive status of this object | reports_put_archive |
Attach an item to a file in a git repo | reports_put_git |
Add a Report to a project | reports_put_projects |
Add a Service Report to a project | reports_put_services_projects |
Set the permissions groups has on this object | reports_put_services_shares_groups |
Set the permissions users have on this object | reports_put_services_shares_users |
Set the permissions groups has on this object | reports_put_shares_groups |
Set the permissions users have on this object | reports_put_shares_users |
Evaluate an R expression in a Civis Platform container | run_civis |
Run a template script | run_template |
Revoke the permissions a group has on this object | saml_service_providers_delete_shares_groups |
Revoke the permissions a user has on this object | saml_service_providers_delete_shares_users |
List users and groups permissioned on this object | saml_service_providers_list_shares |
Set the permissions groups has on this object | saml_service_providers_put_shares_groups |
Set the permissions users have on this object | saml_service_providers_put_shares_users |
Archive a script (deprecated, use archive endpoints instead) | scripts_delete |
Archive a container (deprecated, use archive endpoints) | scripts_delete_containers |
Remove a Container Script from a project | scripts_delete_containers_projects |
Cancel a run | scripts_delete_containers_runs |
Revoke the permissions a group has on this object | scripts_delete_containers_shares_groups |
Revoke the permissions a user has on this object | scripts_delete_containers_shares_users |
Archive a Custom Script (deprecated, use archiving endpoints instead) | scripts_delete_custom |
Remove a Custom Script from a project | scripts_delete_custom_projects |
Cancel a run | scripts_delete_custom_runs |
Revoke the permissions a group has on this object | scripts_delete_custom_shares_groups |
Revoke the permissions a user has on this object | scripts_delete_custom_shares_users |
Archive a JavaScript Script (deprecated, use archiving endpoints instead) | scripts_delete_javascript |
Remove a JavaScript Script from a project | scripts_delete_javascript_projects |
Cancel a run | scripts_delete_javascript_runs |
Revoke the permissions a group has on this object | scripts_delete_javascript_shares_groups |
Revoke the permissions a user has on this object | scripts_delete_javascript_shares_users |
Archive a Python Script (deprecated, use archiving endpoints instead) | scripts_delete_python3 |
Remove a Python Script from a project | scripts_delete_python3_projects |
Cancel a run | scripts_delete_python3_runs |
Revoke the permissions a group has on this object | scripts_delete_python3_shares_groups |
Revoke the permissions a user has on this object | scripts_delete_python3_shares_users |
Archive an R Script (deprecated, use archiving endpoints instead) | scripts_delete_r |
Remove an R Script from a project | scripts_delete_r_projects |
Cancel a run | scripts_delete_r_runs |
Revoke the permissions a group has on this object | scripts_delete_r_shares_groups |
Revoke the permissions a user has on this object | scripts_delete_r_shares_users |
Archive a SQL script (deprecated, use archiving endpoints instead) | scripts_delete_sql |
Remove a SQL script from a project | scripts_delete_sql_projects |
Cancel a run | scripts_delete_sql_runs |
Revoke the permissions a group has on this object | scripts_delete_sql_shares_groups |
Revoke the permissions a user has on this object | scripts_delete_sql_shares_users |
Get details about a script | scripts_get |
View a container | scripts_get_containers |
Check status of a run | scripts_get_containers_runs |
Get a Custom Script | scripts_get_custom |
Check status of a run | scripts_get_custom_runs |
Get a JavaScript Script | scripts_get_javascript |
Get file contents at commit_hash | scripts_get_javascript_git_commits |
Check status of a run | scripts_get_javascript_runs |
Get a Python Script | scripts_get_python3 |
Get file contents at commit_hash | scripts_get_python3_git_commits |
Check status of a run | scripts_get_python3_runs |
Get an R Script | scripts_get_r |
Get file contents at commit_hash | scripts_get_r_git_commits |
Check status of a run | scripts_get_r_runs |
Get a SQL script | scripts_get_sql |
Get file contents at commit_hash | scripts_get_sql_git_commits |
Check status of a run | scripts_get_sql_runs |
List Scripts | scripts_list |
List the projects a Container Script belongs to | scripts_list_containers_projects |
List runs for the given container | scripts_list_containers_runs |
Get the logs for a run | scripts_list_containers_runs_logs |
List the outputs for a run | scripts_list_containers_runs_outputs |
List users and groups permissioned on this object | scripts_list_containers_shares |
List Custom Scripts | scripts_list_custom |
List the projects a Custom Script belongs to | scripts_list_custom_projects |
List runs for the given custom | scripts_list_custom_runs |
Get the logs for a run | scripts_list_custom_runs_logs |
List the outputs for a run | scripts_list_custom_runs_outputs |
List users and groups permissioned on this object | scripts_list_custom_shares |
Get the run history and outputs of this script | scripts_list_history |
Get the git metadata attached to an item | scripts_list_javascript_git |
Get the git commits for an item | scripts_list_javascript_git_commits |
List the projects a JavaScript Script belongs to | scripts_list_javascript_projects |
List runs for the given javascript | scripts_list_javascript_runs |
Get the logs for a run | scripts_list_javascript_runs_logs |
List the outputs for a run | scripts_list_javascript_runs_outputs |
List users and groups permissioned on this object | scripts_list_javascript_shares |
Get the git metadata attached to an item | scripts_list_python3_git |
Get the git commits for an item | scripts_list_python3_git_commits |
List the projects a Python Script belongs to | scripts_list_python3_projects |
List runs for the given python | scripts_list_python3_runs |
Get the logs for a run | scripts_list_python3_runs_logs |
List the outputs for a run | scripts_list_python3_runs_outputs |
List users and groups permissioned on this object | scripts_list_python3_shares |
Get the git metadata attached to an item | scripts_list_r_git |
Get the git commits for an item | scripts_list_r_git_commits |
List the projects an R Script belongs to | scripts_list_r_projects |
List runs for the given r | scripts_list_r_runs |
Get the logs for a run | scripts_list_r_runs_logs |
List the outputs for a run | scripts_list_r_runs_outputs |
List users and groups permissioned on this object | scripts_list_r_shares |
Get the git metadata attached to an item | scripts_list_sql_git |
Get the git commits for an item | scripts_list_sql_git_commits |
List the projects a SQL script belongs to | scripts_list_sql_projects |
List runs for the given sql | scripts_list_sql_runs |
Get the logs for a run | scripts_list_sql_runs_logs |
List the outputs for a run | scripts_list_sql_runs_outputs |
List users and groups permissioned on this object | scripts_list_sql_shares |
List available script types | scripts_list_types |
Update a script | scripts_patch |
Update a container | scripts_patch_containers |
Update some attributes of this Custom Script | scripts_patch_custom |
Update some attributes of this JavaScript Script | scripts_patch_javascript |
Update some attributes of this Python Script | scripts_patch_python3 |
Update some attributes of this R Script | scripts_patch_r |
Update some attributes of this SQL script | scripts_patch_sql |
Create a script | scripts_post |
Cancel a run | scripts_post_cancel |
Create a container | scripts_post_containers |
Clone this Container Script | scripts_post_containers_clone |
Start a run | scripts_post_containers_runs |
Add log messages | scripts_post_containers_runs_logs |
Add an output for a run | scripts_post_containers_runs_outputs |
Create a Custom Script | scripts_post_custom |
Clone this Custom Script | scripts_post_custom_clone |
Start a run | scripts_post_custom_runs |
Add an output for a run | scripts_post_custom_runs_outputs |
Create a JavaScript Script | scripts_post_javascript |
Clone this JavaScript Script | scripts_post_javascript_clone |
Commit and push a new version of the file | scripts_post_javascript_git_commits |
Start a run | scripts_post_javascript_runs |
Add an output for a run | scripts_post_javascript_runs_outputs |
Create a Python Script | scripts_post_python3 |
Clone this Python Script | scripts_post_python3_clone |
Commit and push a new version of the file | scripts_post_python3_git_commits |
Start a run | scripts_post_python3_runs |
Add an output for a run | scripts_post_python3_runs_outputs |
Create an R Script | scripts_post_r |
Clone this R Script | scripts_post_r_clone |
Commit and push a new version of the file | scripts_post_r_git_commits |
Start a run | scripts_post_r_runs |
Add an output for a run | scripts_post_r_runs_outputs |
Run a script | scripts_post_run |
Create a SQL script | scripts_post_sql |
Clone this SQL script | scripts_post_sql_clone |
Commit and push a new version of the file | scripts_post_sql_git_commits |
Start a run | scripts_post_sql_runs |
Edit a container | scripts_put_containers |
Update the archive status of this object | scripts_put_containers_archive |
Add a Container Script to a project | scripts_put_containers_projects |
Set the permissions groups has on this object | scripts_put_containers_shares_groups |
Set the permissions users have on this object | scripts_put_containers_shares_users |
Replace all attributes of this Custom Script | scripts_put_custom |
Update the archive status of this object | scripts_put_custom_archive |
Add a Custom Script to a project | scripts_put_custom_projects |
Set the permissions groups has on this object | scripts_put_custom_shares_groups |
Set the permissions users have on this object | scripts_put_custom_shares_users |
Replace all attributes of this JavaScript Script | scripts_put_javascript |
Update the archive status of this object | scripts_put_javascript_archive |
Attach an item to a file in a git repo | scripts_put_javascript_git |
Add a JavaScript Script to a project | scripts_put_javascript_projects |
Set the permissions groups has on this object | scripts_put_javascript_shares_groups |
Set the permissions users have on this object | scripts_put_javascript_shares_users |
Replace all attributes of this Python Script | scripts_put_python3 |
Update the archive status of this object | scripts_put_python3_archive |
Attach an item to a file in a git repo | scripts_put_python3_git |
Add a Python Script to a project | scripts_put_python3_projects |
Set the permissions groups has on this object | scripts_put_python3_shares_groups |
Set the permissions users have on this object | scripts_put_python3_shares_users |
Replace all attributes of this R Script | scripts_put_r |
Update the archive status of this object | scripts_put_r_archive |
Attach an item to a file in a git repo | scripts_put_r_git |
Add an R Script to a project | scripts_put_r_projects |
Set the permissions groups has on this object | scripts_put_r_shares_groups |
Set the permissions users have on this object | scripts_put_r_shares_users |
Replace all attributes of this SQL script | scripts_put_sql |
Update the archive status of this object | scripts_put_sql_archive |
Attach an item to a file in a git repo | scripts_put_sql_git |
Add a SQL script to a project | scripts_put_sql_projects |
Set the permissions groups has on this object | scripts_put_sql_shares_groups |
Set the permissions users have on this object | scripts_put_sql_shares_users |
Perform a search | search_list |
List available search types | search_list_types |
Archive a Service (deprecated, use archiving endpoints instead) | services_delete |
Delete a Service deployment | services_delete_deployments |
Remove a Service from a project | services_delete_projects |
Revoke the permissions a group has on this object | services_delete_shares_groups |
Revoke the permissions a user has on this object | services_delete_shares_users |
Revoke a token by id | services_delete_tokens |
Get a Service | services_get |
Get details about a Service deployment | services_get_deployments |
List Services | services_list |
List deployments for a Service | services_list_deployments |
Get the logs for a Service deployment | services_list_deployments_logs |
List the projects a Service belongs to | services_list_projects |
List users and groups permissioned on this object | services_list_shares |
List tokens | services_list_tokens |
Update some attributes of this Service | services_patch |
Create a Service | services_post |
Clone this Service | services_post_clone |
Deploy a Service | services_post_deployments |
Redeploy a Service | services_post_redeploy |
Create a new long-lived service token | services_post_tokens |
Replace all attributes of this Service | services_put |
Update the archive status of this object | services_put_archive |
Add a Service to a project | services_put_projects |
Set the permissions groups has on this object | services_put_shares_groups |
Set the permissions users have on this object | services_put_shares_users |
SQL escaping | sql |
Stash a data frame in feather or csv format, depending on CivisML version. | stash_local_dataframe |
Delete a storage host (deprecated) | storage_hosts_delete |
Revoke the permissions a group has on this object | storage_hosts_delete_shares_groups |
Revoke the permissions a user has on this object | storage_hosts_delete_shares_users |
Get a storage host | storage_hosts_get |
List the storage hosts | storage_hosts_list |
List users and groups permissioned on this object | storage_hosts_list_shares |
Update some attributes of this storage host | storage_hosts_patch |
Create a new storage host | storage_hosts_post |
Replace all attributes of this storage host | storage_hosts_put |
Set the permissions groups has on this object | storage_hosts_put_shares_groups |
Set the permissions users have on this object | storage_hosts_put_shares_users |
Remove a Table from a project | tables_delete_projects |
Show basic table info | tables_get |
View the status of a CASS / NCOA table enhancement | tables_get_enhancements_cass_ncoa |
View the status of a geocoding table enhancement | tables_get_enhancements_geocodings |
List tables | tables_list |
List columns in the specified table | tables_list_columns |
List the projects a Table belongs to | tables_list_projects |
Update a table | tables_patch |
Standardize addresses in a table | tables_post_enhancements_cass_ncoa |
Geocode a table | tables_post_enhancements_geocodings |
Request a refresh for column and table statistics | tables_post_refresh |
Creates and enqueues a single table scanner job on a new table | tables_post_scan |
Add a Table to a project | tables_put_projects |
Archive a Report Template (deprecated, use archiving endpoints instead) | templates_delete_reports |
Revoke the permissions a group has on this object | templates_delete_reports_shares_groups |
Revoke the permissions a user has on this object | templates_delete_reports_shares_users |
Archive a Script Template (deprecated, use archiving endpoints instead) | templates_delete_scripts |
Remove a Script Template from a project | templates_delete_scripts_projects |
Revoke the permissions a group has on this object | templates_delete_scripts_shares_groups |
Revoke the permissions a user has on this object | templates_delete_scripts_shares_users |
Get a Report Template | templates_get_reports |
Get a Script Template | templates_get_scripts |
List Report Templates | templates_list_reports |
List users and groups permissioned on this object | templates_list_reports_shares |
List Script Templates | templates_list_scripts |
List the projects a Script Template belongs to | templates_list_scripts_projects |
List users and groups permissioned on this object | templates_list_scripts_shares |
Update some attributes of this Report Template | templates_patch_reports |
Update some attributes of this Script Template | templates_patch_scripts |
Create a Report Template | templates_post_reports |
Review a template for security vulnerability and correctness (admin-only) | templates_post_reports_review |
Create a Script Template | templates_post_scripts |
Review a template for security vulnerability and correctness (admin-only) | templates_post_scripts_review |
Replace all attributes of this Report Template | templates_put_reports |
Set the permissions groups has on this object | templates_put_reports_shares_groups |
Set the permissions users have on this object | templates_put_reports_shares_users |
Replace all attributes of this Script Template | templates_put_scripts |
Add a Script Template to a project | templates_put_scripts_projects |
Set the permissions groups has on this object | templates_put_scripts_shares_groups |
Set the permissions users have on this object | templates_put_scripts_shares_users |
Transfer a table from one location to another. | transfer_table |
Revoke the specified API key | users_delete_api_keys |
Unfavorite an item | users_delete_me_favorites |
Show info about a user | users_get |
Show the specified API key | users_get_api_keys |
List users | users_list |
Show API keys belonging to the specified user | users_list_api_keys |
Show info about the logged-in user | users_list_me |
List Favorites | users_list_me_favorites |
UI configuration for logged-in user | users_list_me_ui |
Update info about a user (must be an admin or client user admin) | users_patch |
Update info about the logged-in user | users_patch_me |
Create a new user (must be an admin or client user admin) | users_post |
Create a new API key belonging to the logged-in user | users_post_api_keys |
Favorite an item | users_post_me_favorites |
Remove a Workflow from a project | workflows_delete_projects |
Revoke the permissions a group has on this object | workflows_delete_shares_groups |
Revoke the permissions a user has on this object | workflows_delete_shares_users |
Get a Workflow | workflows_get |
Get a workflow execution | workflows_get_executions |
Get a task of a workflow execution | workflows_get_executions_tasks |
Get file contents at commit_hash | workflows_get_git_commits |
List Workflows | workflows_list |
List workflow executions | workflows_list_executions |
Get the git metadata attached to an item | workflows_list_git |
Get the git commits for an item | workflows_list_git_commits |
List the projects a Workflow belongs to | workflows_list_projects |
List users and groups permissioned on this object | workflows_list_shares |
Update some attributes of this Workflow | workflows_patch |
Create a Workflow | workflows_post |
Clone this Workflow | workflows_post_clone |
Execute a workflow | workflows_post_executions |
Cancel a workflow execution | workflows_post_executions_cancel |
Resume a paused workflow execution | workflows_post_executions_resume |
Retry a failed task, or all failed tasks in an execution | workflows_post_executions_retry |
Commit and push a new version of the file | workflows_post_git_commits |
Replace all attributes of this Workflow | workflows_put |
Update the archive status of this object | workflows_put_archive |
Attach an item to a file in a git repo | workflows_put_git |
Add a Workflow to a project | workflows_put_projects |
Set the permissions groups has on this object | workflows_put_shares_groups |
Set the permissions users have on this object | workflows_put_shares_users |
Split a file into chunks of a given chunk size, returning a list of file names. | write_chunks |
Upload a local data frame or csv file to the Civis Platform (Redshift) | write_civis write_civis.character write_civis.data.frame write_civis.numeric |
Upload a R object or file to Civis Platform (Files endpoint) | write_civis_file write_civis_file.character write_civis_file.data.frame write_civis_file.default |
Add a file as a run output if called from a container job | write_job_output |