Enhancements

class Enhancements(session_kwargs, client, return_type='raw')

Methods

`delete_cass_ncoa_projects`(id, project_id)	Remove a CASS/NCOA Enhancement from a project
`delete_cass_ncoa_runs`(id, run_id)	Cancel a run
`delete_cass_ncoa_shares_groups`(id, group_id)	Revoke the permissions a group has on this object
`delete_cass_ncoa_shares_users`(id, user_id)	Revoke the permissions a user has on this object
`delete_civis_data_match_projects`(id, project_id)	Remove a Civis Data Match Enhancement from a project
`delete_civis_data_match_runs`(id, run_id)	Cancel a run
`delete_civis_data_match_shares_groups`(id, ...)	Revoke the permissions a group has on this object
`delete_civis_data_match_shares_users`(id, user_id)	Revoke the permissions a user has on this object
`delete_geocode_projects`(id, project_id)	Remove a Geocode Enhancement from a project
`delete_geocode_runs`(id, run_id)	Cancel a run
`delete_geocode_shares_groups`(id, group_id)	Revoke the permissions a group has on this object
`delete_geocode_shares_users`(id, user_id)	Revoke the permissions a user has on this object
`delete_identity_resolution_projects`(id, ...)	Remove an Identity Resolution Enhancement from a project
`delete_identity_resolution_runs`(id, run_id)	Cancel a run
`delete_identity_resolution_shares_groups`(id, ...)	Revoke the permissions a group has on this object
`delete_identity_resolution_shares_users`(id, ...)	Revoke the permissions a user has on this object
`get_cass_ncoa`(id)	Get a CASS/NCOA Enhancement
`get_cass_ncoa_runs`(id, run_id)	Check status of a run
`get_civis_data_match`(id)	Get a Civis Data Match Enhancement
`get_civis_data_match_runs`(id, run_id)	Check status of a run
`get_geocode`(id)	Get a Geocode Enhancement
`get_geocode_runs`(id, run_id)	Check status of a run
`get_identity_resolution`(id, *[, is_legacy_id])	Get an Identity Resolution Enhancement
`get_identity_resolution_runs`(id, run_id)	Check status of a run
`list`(*[, type, author, status, archived, ...])	List Enhancements
`list_cass_ncoa_dependencies`(id, *[, user_id])	List dependent objects for this object
`list_cass_ncoa_projects`(id, *[, hidden])	List the projects a CASS/NCOA Enhancement belongs to
`list_cass_ncoa_runs`(id, *[, limit, ...])	List runs for the given CASS NCOA job
`list_cass_ncoa_runs_logs`(id, run_id, *[, ...])	Get the logs for a run
`list_cass_ncoa_runs_outputs`(id, run_id, *[, ...])	List the outputs for a run
`list_cass_ncoa_shares`(id)	List users and groups permissioned on this object
`list_civis_data_match_dependencies`(id, *[, ...])	List dependent objects for this object
`list_civis_data_match_projects`(id, *[, hidden])	List the projects a Civis Data Match Enhancement belongs to
`list_civis_data_match_runs`(id, *[, limit, ...])	List runs for the given Civis Data Match job
`list_civis_data_match_runs_logs`(id, run_id, *)	Get the logs for a run
`list_civis_data_match_runs_outputs`(id, run_id, *)	List the outputs for a run
`list_civis_data_match_shares`(id)	List users and groups permissioned on this object
`list_field_mapping`()	List the fields in a field mapping for Civis Data Match, Data Unification, and Table Deduplication jobs
`list_geocode_dependencies`(id, *[, user_id])	List dependent objects for this object
`list_geocode_projects`(id, *[, hidden])	List the projects a Geocode Enhancement belongs to
`list_geocode_runs`(id, *[, limit, page_num, ...])	List runs for the given Geocode job
`list_geocode_runs_logs`(id, run_id, *[, ...])	Get the logs for a run
`list_geocode_runs_outputs`(id, run_id, *[, ...])	List the outputs for a run
`list_geocode_shares`(id)	List users and groups permissioned on this object
`list_identity_resolution`(*[, archived, ...])	List Identity Resolution Enhancements
`list_identity_resolution_dependencies`(id, *)	List dependent objects for this object
`list_identity_resolution_projects`(id, *[, ...])	List the projects an Identity Resolution Enhancement belongs to
`list_identity_resolution_runs`(id, *[, ...])	List runs for the given Identity Resolution job
`list_identity_resolution_runs_logs`(id, run_id, *)	Get the logs for a run
`list_identity_resolution_shares`(id)	List users and groups permissioned on this object
`list_types`()	List available enhancement types
`patch_cass_ncoa`(id, *[, name, schedule, ...])	Update some attributes of this CASS/NCOA Enhancement
`patch_civis_data_match`(id, *[, name, ...])	Update some attributes of this Civis Data Match Enhancement
`patch_geocode`(id, *[, name, schedule, ...])	Update some attributes of this Geocode Enhancement
`patch_identity_resolution`(id, *[, name, ...])	Update some attributes of this Identity Resolution Enhancement
`post_cass_ncoa`(name, source, *[, schedule, ...])	Create a CASS/NCOA Enhancement
`post_cass_ncoa_cancel`(id)	Cancel a run
`post_cass_ncoa_runs`(id)	Start a run
`post_civis_data_match`(name, ...[, schedule, ...])	Create a Civis Data Match Enhancement
`post_civis_data_match_cancel`(id)	Cancel a run
`post_civis_data_match_clone`(id, *[, ...])	Clone this Civis Data Match Enhancement
`post_civis_data_match_runs`(id)	Start a run
`post_geocode`(name, remote_host_id, ...[, ...])	Create a Geocode Enhancement
`post_geocode_cancel`(id)	Cancel a run
`post_geocode_runs`(id)	Start a run
`post_identity_resolution`(name, sources, *[, ...])	Create an Identity Resolution Enhancement
`post_identity_resolution_cancel`(id)	Cancel a run
`post_identity_resolution_clone`(id, *[, ...])	Clone this Identity Resolution Enhancement
`post_identity_resolution_runs`(id)	Start a run
`put_cass_ncoa`(id, name, source, *[, ...])	Replace all attributes of this CASS/NCOA Enhancement
`put_cass_ncoa_archive`(id, status)	Update the archive status of this object
`put_cass_ncoa_projects`(id, project_id)	Add a CASS/NCOA Enhancement to a project
`put_cass_ncoa_shares_groups`(id, group_ids, ...)	Set the permissions groups has on this object
`put_cass_ncoa_shares_users`(id, user_ids, ...)	Set the permissions users have on this object
`put_cass_ncoa_transfer`(id, user_id, ...[, ...])	Transfer ownership of this object to another user
`put_civis_data_match`(id, name, ...[, ...])	Replace all attributes of this Civis Data Match Enhancement
`put_civis_data_match_archive`(id, status)	Update the archive status of this object
`put_civis_data_match_projects`(id, project_id)	Add a Civis Data Match Enhancement to a project
`put_civis_data_match_shares_groups`(id, ...)	Set the permissions groups has on this object
`put_civis_data_match_shares_users`(id, ...[, ...])	Set the permissions users have on this object
`put_civis_data_match_transfer`(id, user_id, ...)	Transfer ownership of this object to another user
`put_geocode`(id, name, remote_host_id, ...[, ...])	Replace all attributes of this Geocode Enhancement
`put_geocode_archive`(id, status)	Update the archive status of this object
`put_geocode_projects`(id, project_id)	Add a Geocode Enhancement to a project
`put_geocode_shares_groups`(id, group_ids, ...)	Set the permissions groups has on this object
`put_geocode_shares_users`(id, user_ids, ...)	Set the permissions users have on this object
`put_geocode_transfer`(id, user_id, ...[, ...])	Transfer ownership of this object to another user
`put_identity_resolution`(id, name, sources, *)	Replace all attributes of this Identity Resolution Enhancement
`put_identity_resolution_archive`(id, status)	Update the archive status of this object
`put_identity_resolution_projects`(id, project_id)	Add an Identity Resolution Enhancement to a project
`put_identity_resolution_shares_groups`(id, ...)	Set the permissions groups has on this object
`put_identity_resolution_shares_users`(id, ...)	Set the permissions users have on this object
`put_identity_resolution_transfer`(id, ...[, ...])	Transfer ownership of this object to another user

Examples

>>> import civis
>>> client = civis.APIClient()
>>> client.enhancements.post_civis_data_match(...)

delete_cass_ncoa_projects(id: int, project_id: int) → Response

Remove a CASS/NCOA Enhancement from a project

Parameters:

idint: The ID of the CASS/NCOA Enhancement.
project_idint: The ID of the project.

Returns:

None: Response code 204: success

delete_cass_ncoa_runs(id: int, run_id: int) → Response

Cancel a run

Parameters:

idint: The ID of the CASS NCOA job.
run_idint: The ID of the run.

Returns:

None: Response code 202: success

delete_cass_ncoa_shares_groups(id: int, group_id: int) → Response

Revoke the permissions a group has on this object

Parameters:

idint: The ID of the resource that is shared.
group_idint: The ID of the group.

Returns:

None: Response code 204: success

delete_cass_ncoa_shares_users(id: int, user_id: int) → Response

Revoke the permissions a user has on this object

Parameters:

idint: The ID of the resource that is shared.
user_idint: The ID of the user.

Returns:

None: Response code 204: success

delete_civis_data_match_projects(id: int, project_id: int) → Response

Remove a Civis Data Match Enhancement from a project

Parameters:

idint: The ID of the Civis Data Match Enhancement.
project_idint: The ID of the project.

Returns:

None: Response code 204: success

delete_civis_data_match_runs(id: int, run_id: int) → Response

Cancel a run

Parameters:

idint: The ID of the Civis Data Match job.
run_idint: The ID of the run.

Returns:

None: Response code 202: success

delete_civis_data_match_shares_groups(id: int, group_id: int) → Response

Revoke the permissions a group has on this object

Parameters:

idint: The ID of the resource that is shared.
group_idint: The ID of the group.

Returns:

None: Response code 204: success

delete_civis_data_match_shares_users(id: int, user_id: int) → Response

Revoke the permissions a user has on this object

Parameters:

idint: The ID of the resource that is shared.
user_idint: The ID of the user.

Returns:

None: Response code 204: success

delete_geocode_projects(id: int, project_id: int) → Response

Remove a Geocode Enhancement from a project

Parameters:

idint: The ID of the Geocode Enhancement.
project_idint: The ID of the project.

Returns:

None: Response code 204: success

delete_geocode_runs(id: int, run_id: int) → Response

Cancel a run

Parameters:

idint: The ID of the Geocode job.
run_idint: The ID of the run.

Returns:

None: Response code 202: success

delete_geocode_shares_groups(id: int, group_id: int) → Response

Revoke the permissions a group has on this object

Parameters:

idint: The ID of the resource that is shared.
group_idint: The ID of the group.

Returns:

None: Response code 204: success

delete_geocode_shares_users(id: int, user_id: int) → Response

Revoke the permissions a user has on this object

Parameters:

idint: The ID of the resource that is shared.
user_idint: The ID of the user.

Returns:

None: Response code 204: success

delete_identity_resolution_projects(id: int, project_id: int) → Response

Remove an Identity Resolution Enhancement from a project

Parameters:

idint: The ID of the Identity Resolution Enhancement.
project_idint: The ID of the project.

Returns:

None: Response code 204: success

delete_identity_resolution_runs(id: int, run_id: int) → Response

Cancel a run

Parameters:

idint: The ID of the Identity Resolution job.
run_idint: The ID of the run.

Returns:

None: Response code 202: success

delete_identity_resolution_shares_groups(id: int, group_id: int) → Response

Revoke the permissions a group has on this object

Parameters:

idint: The ID of the resource that is shared.
group_idint: The ID of the group.

Returns:

None: Response code 204: success

delete_identity_resolution_shares_users(id: int, user_id: int) → Response

Revoke the permissions a user has on this object

Parameters:

idint: The ID of the resource that is shared.
user_idint: The ID of the user.

Returns:

None: Response code 204: success

get_cass_ncoa(id: int) → Response

Get a CASS/NCOA Enhancement

Parameters:

idint

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
sourcecivis.Response
- database_tablecivis.Response
  
  schemastr
  The schema name of the source table.
  
  tablestr
  The name of the source table.
  
  remote_host_idint
  The ID of the database host for the table.
  
  credential_idint
  The id of the credentials to be used when performing the enhancement.
  
  multipart_keyList[str]
  The source table primary key.
destinationcivis.Response
- database_tablecivis.Response
  
  schemastr
  The schema name for the output data.
  
  tablestr
  The table name for the output data.
column_mappingcivis.Response
- address1str
  The first address line.
- address2str
  The second address line.
- citystr
  The city of an address.
- statestr
  The state of an address.
- zipstr
  The zip code of an address.
- namestr
  The full name of the resident at this address. If needed, separate multiple columns with +, e.g. first_name+last_name
- companystr
  The name of the company located at this address.
use_default_column_mappingbool
Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.
perform_ncoabool
Whether to update addresses for records matching the National Change of Address (NCOA) database.
ncoa_credential_idint
Credential to use when performing NCOA updates. Required if ‘performNcoa’ is true.
output_levelstr
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.
limiting_sqlstr
The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).
batch_sizeint
The maximum number of records processed at a time. Note that this parameter is not available to all users.
archivedstr
The archival status of the requested item(s).
parent_idint
Parent ID that triggers this enhancement.

get_cass_ncoa_runs(id: int, run_id: int) → Response

Check status of a run

Parameters:

idint: The ID of the CASS NCOA job.
run_idint: The ID of the run.

Returns:

civis.Response

idint
The ID of the run.
cass_ncoa_idint
The ID of the CASS NCOA job.
statestr
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.
created_atstr (time)
The time the run was created.
started_atstr (time)
The time the run started at.
finished_atstr (time)
The time the run completed.
errorstr
The error, if any, returned by the run.

get_civis_data_match(id: int) → Response

Get a Civis Data Match Enhancement

Parameters:

idint

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
input_field_mappingcivis.Response
The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the “phone” field), a list of column names can be provided (e.g., {“phone”: [“home_phone”, “mobile_phone”], …}).
input_tablecivis.Response
- database_namestr
  The Redshift database name for the table.
- schemastr
  The schema name for the table.
- tablestr
  The table name.
match_target_idint
The ID of the Civis Data match target. See /match_targets for IDs.
output_tablecivis.Response
- database_namestr
  The Redshift database name for the table.
- schemastr
  The schema name for the table.
- tablestr
  The table name.
max_matchesint
The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.
thresholdfloat (float)
The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.
archivedbool
Whether the Civis Data Match Job has been archived.
last_runcivis.Response
- id : int
- state : str
- created_atstr (time)
  The time that the run was queued.
- started_atstr (time)
  The time that the run started.
- finished_atstr (time)
  The time that the run completed.
- errorstr
  The error message for this run, if present.
parent_idint
Parent ID that triggers this enhancement.

get_civis_data_match_runs(id: int, run_id: int) → Response

Check status of a run

Parameters:

idint: The ID of the Civis Data Match job.
run_idint: The ID of the run.

Returns:

civis.Response

idint
The ID of the run.
civis_data_match_idint
The ID of the Civis Data Match job.
statestr
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.
created_atstr (time)
The time the run was created.
started_atstr (time)
The time the run started at.
finished_atstr (time)
The time the run completed.
errorstr
The error, if any, returned by the run.

get_geocode(id: int) → Response

Get a Geocode Enhancement

Parameters:

idint

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
remote_host_idint
The ID of the remote host.
credential_idint
The ID of the remote host credential.
source_schema_and_tablestr
The source database schema and table.
multipart_keyList[str]
The source table primary key.
limiting_sqlstr
The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).
target_schemastr
The output table schema.
target_tablestr
The output table name.
countrystr
The country of the addresses to be geocoded; either ‘us’ or ‘ca’.
providerstr
The geocoding provider; one of postgis and geocoder_ca.
output_addressbool
Whether to output the parsed address. Only guaranteed for the ‘postgis’ provider.
archivedstr
The archival status of the requested item(s).
parent_idint
Parent ID that triggers this enhancement.

get_geocode_runs(id: int, run_id: int) → Response

Check status of a run

Parameters:

idint: The ID of the Geocode job.
run_idint: The ID of the run.

Returns:

civis.Response

idint
The ID of the run.
geocode_idint
The ID of the Geocode job.
statestr
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.
created_atstr (time)
The time the run was created.
started_atstr (time)
The time the run started at.
finished_atstr (time)
The time the run completed.
errorstr
The error, if any, returned by the run.

get_identity_resolution(id: int, *, is_legacy_id: bool = None) → Response

Get an Identity Resolution Enhancement

Parameters:

idint: The ID for the enhancement.
is_legacy_idbool, optional: Whether the given ID is for the Identity Resolution job in the legacy service app.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
archivedstr
The archival status of the requested item(s).
thresholdfloat (float)
A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.
sourcesList[civis.Response]
The source(s) to resolve via a run of this job.
- namestr
  A user-specified name for the source.
- descriptionstr
  A description of the source.
- database_namestr
  The name of the source database.
- schema_namestr
  The name of the source schema.
- table_namestr
  The name of the source table.
- field_mappingcivis.Response
  A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix
match_target_idint
The ID of the Civis Data (Custom) match target. See /match_targets for IDs.
enforced_linksList[civis.Response]
A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.
- source1str
  Name of the first source. Must be defined in Sources list.
- source1_join_colstr
  Column from the first source to join on.
- source2str
  Name of the second source. Must be defined in Sources list
- source2_join_colstr
  Column from the second source to join on.
customer_graphcivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
golden_tablecivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
- fieldsList[civis.Response]
  
  field_namestr
  The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.
  
  rule_typestr
  One of [“automatic”, “preferred_source”]. Determines how the system will choose the value for a record. “automatic” will use the most frequent well-formatted value. “preferred_source” allows the user to prioritize values from particular sources over others.
  
  source_preferencesList[civis.Response]
  Rank order for sources, when rule_type is “preferred_source”.
  
  source_namestr
  The name of the source.
  
  rankingint
  How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.
link_scorescivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
legacy_idint
ID of this pipeline in the legacy IDR service application.
last_runcivis.Response
- id : int
- state : str
- created_atstr (time)
  The time that the run was queued.
- started_atstr (time)
  The time that the run started.
- finished_atstr (time)
  The time that the run completed.
- errorstr
  The error message for this run, if present.
- configstr
  How the Identity Resolution job was configured for this run.
- sample_records_querystr
  A SQL query to produce a sample of records to inspect.
- expand_cluster_querystr
  A customizable query to view PII associated with resolved ids.
- run_metricscivis.Response
  
  num_recordsint
  The number of input records for this run.
  
  unique_idsint
  The number of distinct unique IDs in the input records for this run.
  
  unique_deduplicated_idsint
  The number of resolved IDs associated with more than one unique ID in the input.
  
  max_cluster_sizeint
  The number of records in the largest cluster of resolved IDs.
  
  avg_cluster_sizefloat (float)
  The average number of records with the same resolved ID.
  
  cluster_size_frequenciescivis.Response
  A mapping from numbers of records with the same resolved ID (i.e., sizes of clusters) to numbers of such clusters. For example, if there were 10 clusters with 2 records each, 2 would be a key in the mapping, and 10 would be its value.
- error_sectionstr
  If there was a failure, this will denote which section of the Identity Resolution job failed. One of: data_preparation, compute_setup or data_processing.

get_identity_resolution_runs(id: int, run_id: int) → Response

Check status of a run

Parameters:

idint: The ID of the Identity Resolution job.
run_idint: The ID of the run.

Returns:

civis.Response

idint
The ID of the run.
identity_resolution_idint
The ID of the Identity Resolution job.
statestr
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.
created_atstr (time)
The time the run was created.
started_atstr (time)
The time the run started at.
finished_atstr (time)
The time the run completed.
errorstr
The error, if any, returned by the run.
configstr
How the Identity Resolution job was configured for this run.
sample_records_querystr
A SQL query to produce a sample of records to inspect.
expand_cluster_querystr
A customizable query to view PII associated with resolved ids.
run_metricscivis.Response
- num_recordsint
  The number of input records for this run.
- unique_idsint
  The number of distinct unique IDs in the input records for this run.
- unique_deduplicated_idsint
  The number of resolved IDs associated with more than one unique ID in the input.
- max_cluster_sizeint
  The number of records in the largest cluster of resolved IDs.
- avg_cluster_sizefloat (float)
  The average number of records with the same resolved ID.
- cluster_size_frequenciescivis.Response
  A mapping from numbers of records with the same resolved ID (i.e., sizes of clusters) to numbers of such clusters. For example, if there were 10 clusters with 2 records each, 2 would be a key in the mapping, and 10 would be its value.
error_sectionstr
If there was a failure, this will denote which section of the Identity Resolution job failed. One of: data_preparation, compute_setup or data_processing.

list(*, type: str = None, author: str = None, status: str = None, archived: str = None, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → list[Response] | PaginatedResponse

List Enhancements

Parameters:

typestr, optional: If specified, return items of these types.
authorstr, optional: If specified, return items from any of these authors. It accepts a comma- separated list of user IDs.
statusstr, optional: If specified, returns items with one of these statuses. It accepts a comma- separated list, possible values are ‘running’, ‘failed’, ‘succeeded’, ‘idle’, ‘scheduled’.
archivedstr, optional: The archival status of the requested item(s).
limitint, optional: Number of results to return. Defaults to 20. Maximum allowed is 50.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, 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_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a list of civis.Response objects, whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.PaginatedResponse

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
archivedstr
The archival status of the requested item(s).

list_cass_ncoa_dependencies(id: int, *, user_id: int = None) → Response

List dependent objects for this object

Parameters:

idint: The ID of the resource that is shared.
user_idint, optional: ID of target user

Returns:

civis.Response

object_typestr
Dependent object type
fco_typestr
Human readable dependent object type
idint
Dependent object ID
namestr
Dependent object name, or nil if the requesting user cannot read this object
permission_levelstr
Permission level of target user (not user’s groups) for dependent object. Null if no target user or not shareable (e.g. a database table).
descriptionstr
Additional information about the dependency, if relevant
shareablebool
Whether or not the requesting user can share this object.

list_cass_ncoa_projects(id: int, *, hidden: bool = None) → Response

List the projects a CASS/NCOA Enhancement belongs to

Parameters:

idint: The ID of the CASS/NCOA Enhancement.
hiddenbool, optional: If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.

Returns:

civis.Response

idint
The ID for this project.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of this project.
descriptionstr
A description of the project.
usersList[civis.Response]
Users who can see the project.
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
auto_share : bool
created_at : str (time)
updated_at : str (time)
archivedstr
The archival status of the requested item(s).

list_cass_ncoa_runs(id: int, *, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → list[Response] | PaginatedResponse

List runs for the given CASS NCOA job

Parameters:

idint: The ID of the CASS NCOA job.
limitint, optional: Number of results to return. Defaults to 20. Maximum allowed is 100.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to id. Must be one of: id.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a list of civis.Response objects, whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.PaginatedResponse

idint
The ID of the run.
cass_ncoa_idint
The ID of the CASS NCOA job.
statestr
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.
created_atstr (time)
The time the run was created.
started_atstr (time)
The time the run started at.
finished_atstr (time)
The time the run completed.
errorstr
The error, if any, returned by the run.

list_cass_ncoa_runs_logs(id: int, run_id: int, *, last_id: int = None, limit: int = None) → Response

Get the logs for a run

Parameters:

idint: The ID of the CASS NCOA job.
run_idint: The ID of the run.
last_idint, 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.
limitint, optional: The maximum number of log messages to return. Default of 10000.

Returns:

civis.Response

idint
The ID of the log.
created_atstr (date-time)
The time the log was created.
messagestr
The log message.
levelstr
The level of the log. One of unknown,fatal,error,warn,info,debug.

list_cass_ncoa_runs_outputs(id: int, run_id: int, *, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → list[Response] | PaginatedResponse

List the outputs for a run

Parameters:

idint: The ID of the job.
run_idint: The ID of the run.
limitint, optional: Number of results to return. Defaults to its maximum of 50.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a list of civis.Response objects, whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.PaginatedResponse

object_typestr
The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue
object_idint
The ID of the output.
namestr
The name of the output.
linkstr
The hypermedia link to the output.
value : object

list_cass_ncoa_shares(id: int) → Response

List users and groups permissioned on this object

Parameters:

idint: The ID of the resource that is shared.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

list_civis_data_match_dependencies(id: int, *, user_id: int = None) → Response

List dependent objects for this object

Parameters:

idint: The ID of the resource that is shared.
user_idint, optional: ID of target user

Returns:

civis.Response

object_typestr
Dependent object type
fco_typestr
Human readable dependent object type
idint
Dependent object ID
namestr
Dependent object name, or nil if the requesting user cannot read this object
permission_levelstr
Permission level of target user (not user’s groups) for dependent object. Null if no target user or not shareable (e.g. a database table).
descriptionstr
Additional information about the dependency, if relevant
shareablebool
Whether or not the requesting user can share this object.

list_civis_data_match_projects(id: int, *, hidden: bool = None) → Response

List the projects a Civis Data Match Enhancement belongs to

Parameters:

idint: The ID of the Civis Data Match Enhancement.
hiddenbool, optional: If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.

Returns:

civis.Response

idint
The ID for this project.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of this project.
descriptionstr
A description of the project.
usersList[civis.Response]
Users who can see the project.
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
auto_share : bool
created_at : str (time)
updated_at : str (time)
archivedstr
The archival status of the requested item(s).

list_civis_data_match_runs(id: int, *, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → list[Response] | PaginatedResponse

List runs for the given Civis Data Match job

Parameters:

idint: The ID of the Civis Data Match job.
limitint, optional: Number of results to return. Defaults to 20. Maximum allowed is 100.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to id. Must be one of: id.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a list of civis.Response objects, whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.PaginatedResponse

idint
The ID of the run.
civis_data_match_idint
The ID of the Civis Data Match job.
statestr
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.
created_atstr (time)
The time the run was created.
started_atstr (time)
The time the run started at.
finished_atstr (time)
The time the run completed.
errorstr
The error, if any, returned by the run.

list_civis_data_match_runs_logs(id: int, run_id: int, *, last_id: int = None, limit: int = None) → Response

Get the logs for a run

Parameters:

idint: The ID of the Civis Data Match job.
run_idint: The ID of the run.
last_idint, 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.
limitint, optional: The maximum number of log messages to return. Default of 10000.

Returns:

civis.Response

idint
The ID of the log.
created_atstr (date-time)
The time the log was created.
messagestr
The log message.
levelstr
The level of the log. One of unknown,fatal,error,warn,info,debug.

list_civis_data_match_runs_outputs(id: int, run_id: int, *, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → list[Response] | PaginatedResponse

List the outputs for a run

Parameters:

idint: The ID of the job.
run_idint: The ID of the run.
limitint, optional: Number of results to return. Defaults to its maximum of 50.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a list of civis.Response objects, whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.PaginatedResponse

object_typestr
The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue
object_idint
The ID of the output.
namestr
The name of the output.
linkstr
The hypermedia link to the output.
value : object

list_civis_data_match_shares(id: int) → Response

List users and groups permissioned on this object

Parameters:

idint: The ID of the resource that is shared.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

list_field_mapping() → Response

List the fields in a field mapping for Civis Data Match, Data Unification, and Table Deduplication jobs

Returns:

civis.Response

fieldstr
The name of the field.
descriptionstr
The description of the field.

list_geocode_dependencies(id: int, *, user_id: int = None) → Response

List dependent objects for this object

Parameters:

idint: The ID of the resource that is shared.
user_idint, optional: ID of target user

Returns:

civis.Response

object_typestr
Dependent object type
fco_typestr
Human readable dependent object type
idint
Dependent object ID
namestr
Dependent object name, or nil if the requesting user cannot read this object
permission_levelstr
Permission level of target user (not user’s groups) for dependent object. Null if no target user or not shareable (e.g. a database table).
descriptionstr
Additional information about the dependency, if relevant
shareablebool
Whether or not the requesting user can share this object.

list_geocode_projects(id: int, *, hidden: bool = None) → Response

List the projects a Geocode Enhancement belongs to

Parameters:

idint: The ID of the Geocode Enhancement.
hiddenbool, optional: If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.

Returns:

civis.Response

idint
The ID for this project.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of this project.
descriptionstr
A description of the project.
usersList[civis.Response]
Users who can see the project.
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
auto_share : bool
created_at : str (time)
updated_at : str (time)
archivedstr
The archival status of the requested item(s).

list_geocode_runs(id: int, *, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → list[Response] | PaginatedResponse

List runs for the given Geocode job

Parameters:

idint: The ID of the Geocode job.
limitint, optional: Number of results to return. Defaults to 20. Maximum allowed is 100.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to id. Must be one of: id.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a list of civis.Response objects, whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.PaginatedResponse

idint
The ID of the run.
geocode_idint
The ID of the Geocode job.
statestr
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.
created_atstr (time)
The time the run was created.
started_atstr (time)
The time the run started at.
finished_atstr (time)
The time the run completed.
errorstr
The error, if any, returned by the run.

list_geocode_runs_logs(id: int, run_id: int, *, last_id: int = None, limit: int = None) → Response

Get the logs for a run

Parameters:

idint: The ID of the Geocode job.
run_idint: The ID of the run.
last_idint, 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.
limitint, optional: The maximum number of log messages to return. Default of 10000.

Returns:

civis.Response

idint
The ID of the log.
created_atstr (date-time)
The time the log was created.
messagestr
The log message.
levelstr
The level of the log. One of unknown,fatal,error,warn,info,debug.

list_geocode_runs_outputs(id: int, run_id: int, *, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → list[Response] | PaginatedResponse

List the outputs for a run

Parameters:

idint: The ID of the job.
run_idint: The ID of the run.
limitint, optional: Number of results to return. Defaults to its maximum of 50.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a list of civis.Response objects, whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.PaginatedResponse

object_typestr
The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue
object_idint
The ID of the output.
namestr
The name of the output.
linkstr
The hypermedia link to the output.
value : object

list_geocode_shares(id: int) → Response

List users and groups permissioned on this object

Parameters:

idint: The ID of the resource that is shared.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

list_identity_resolution(*, archived: str = None, status: str = None, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → list[Response] | PaginatedResponse

List Identity Resolution Enhancements

Parameters:

archivedstr, optional: The archival status of the requested item(s).
statusstr, optional: If specified, returns items with one of these statuses. It accepts a comma- separated list, possible values are ‘running’, ‘failed’, ‘succeeded’, ‘idle’, ‘scheduled’.
limitint, optional: Number of results to return. Defaults to 50. Maximum allowed is 100.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, last_run_updated_at.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a list of civis.Response objects, whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.PaginatedResponse

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
archivedstr
The archival status of the requested item(s).
sourcesList[civis.Response]
The source(s) to resolve via a run of this job.
- namestr
  A user-specified name for the source.
last_runcivis.Response
- id : int
- state : str
- created_atstr (time)
  The time that the run was queued.
- started_atstr (time)
  The time that the run started.
- finished_atstr (time)
  The time that the run completed.
- errorstr
  The error message for this run, if present.
- sample_records_querystr
  A SQL query to produce a sample of records to inspect.
- expand_cluster_querystr
  A customizable query to view PII associated with resolved ids.
- run_metricscivis.Response
  
  num_recordsint
  The number of input records for this run.
  
  unique_idsint
  The number of distinct unique IDs in the input records for this run.
  
  unique_deduplicated_idsint
  The number of resolved IDs associated with more than one unique ID in the input.
  
  max_cluster_sizeint
  The number of records in the largest cluster of resolved IDs.
  
  avg_cluster_sizefloat (float)
  The average number of records with the same resolved ID.
  
  cluster_size_frequenciescivis.Response
  A mapping from numbers of records with the same resolved ID (i.e., sizes of clusters) to numbers of such clusters. For example, if there were 10 clusters with 2 records each, 2 would be a key in the mapping, and 10 would be its value.

list_identity_resolution_dependencies(id: int, *, user_id: int = None) → Response

List dependent objects for this object

Parameters:

idint: The ID of the resource that is shared.
user_idint, optional: ID of target user

Returns:

civis.Response

object_typestr
Dependent object type
fco_typestr
Human readable dependent object type
idint
Dependent object ID
namestr
Dependent object name, or nil if the requesting user cannot read this object
permission_levelstr
Permission level of target user (not user’s groups) for dependent object. Null if no target user or not shareable (e.g. a database table).
descriptionstr
Additional information about the dependency, if relevant
shareablebool
Whether or not the requesting user can share this object.

list_identity_resolution_projects(id: int, *, hidden: bool = None) → Response

List the projects an Identity Resolution Enhancement belongs to

Parameters:

idint: The ID of the Identity Resolution Enhancement.
hiddenbool, optional: If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.

Returns:

civis.Response

idint
The ID for this project.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of this project.
descriptionstr
A description of the project.
usersList[civis.Response]
Users who can see the project.
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
auto_share : bool
created_at : str (time)
updated_at : str (time)
archivedstr
The archival status of the requested item(s).

list_identity_resolution_runs(id: int, *, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → list[Response] | PaginatedResponse

List runs for the given Identity Resolution job

Parameters:

idint: The ID of the Identity Resolution job.
limitint, optional: Number of results to return. Defaults to 20. Maximum allowed is 100.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to id. Must be one of: id.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a list of civis.Response objects, whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.PaginatedResponse

idint
The ID of the run.
identity_resolution_idint
The ID of the Identity Resolution job.
statestr
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.
created_atstr (time)
The time the run was created.
started_atstr (time)
The time the run started at.
finished_atstr (time)
The time the run completed.
errorstr
The error, if any, returned by the run.
sample_records_querystr
A SQL query to produce a sample of records to inspect.
expand_cluster_querystr
A customizable query to view PII associated with resolved ids.
run_metricscivis.Response
- num_recordsint
  The number of input records for this run.
- unique_idsint
  The number of distinct unique IDs in the input records for this run.
- unique_deduplicated_idsint
  The number of resolved IDs associated with more than one unique ID in the input.
- max_cluster_sizeint
  The number of records in the largest cluster of resolved IDs.
- avg_cluster_sizefloat (float)
  The average number of records with the same resolved ID.
- cluster_size_frequenciescivis.Response
  A mapping from numbers of records with the same resolved ID (i.e., sizes of clusters) to numbers of such clusters. For example, if there were 10 clusters with 2 records each, 2 would be a key in the mapping, and 10 would be its value.

list_identity_resolution_runs_logs(id: int, run_id: int, *, last_id: int = None, limit: int = None) → Response

Get the logs for a run

Parameters:

idint: The ID of the Identity Resolution job.
run_idint: The ID of the run.
last_idint, 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.
limitint, optional: The maximum number of log messages to return. Default of 10000.

Returns:

civis.Response

idint
The ID of the log.
created_atstr (date-time)
The time the log was created.
messagestr
The log message.
levelstr
The level of the log. One of unknown,fatal,error,warn,info,debug.

list_identity_resolution_shares(id: int) → Response

List users and groups permissioned on this object

Parameters:

idint: The ID of the resource that is shared.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

list_types() → Response

List available enhancement types

Returns:

civis.Response

namestr
The name of the type.

patch_cass_ncoa(id: int, *, name: str = None, schedule: dict = None, notifications: dict = None, source: dict = None, destination: dict = None, column_mapping: dict = None, use_default_column_mapping: bool = None, perform_ncoa: bool = None, ncoa_credential_id: int = None, output_level: str = None, limiting_sql: str = None, batch_size: int = None, parent_id: int = None) → Response

Update some attributes of this CASS/NCOA Enhancement

Parameters:

idint

The ID for the enhancement.

namestr, optional

The name of the enhancement job.

scheduledict, optional

scheduledbool
If the item is scheduled.
scheduled_daysList[int]
Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
scheduled_hoursList[int]
Hours of the day it is scheduled on.
scheduled_minutesList[int]
Minutes of the day it is scheduled on.
scheduled_runs_per_hourint
Deprecated in favor of scheduled minutes.
scheduled_days_of_monthList[int]
Days of the month it is scheduled on, mutually exclusive with scheduledDays.

notificationsdict, optional

urlsList[str]
URLs to receive a POST request at job completion
success_email_subjectstr
Custom subject line for success e-mail.
success_email_bodystr
Custom body text for success e-mail, written in Markdown.
success_email_addressesList[str]
Addresses to notify by e-mail when the job completes successfully.
success_email_from_namestr
Name from which success emails are sent; defaults to “Civis.”
success_email_reply_tostr
Address for replies to success emails; defaults to the author of the job.
failure_email_addressesList[str]
Addresses to notify by e-mail when the job fails.
stall_warning_minutesint
Stall warning emails will be sent after this amount of minutes.
success_onbool
If success email notifications are on. Defaults to user’s preferences.
failure_onbool
If failure email notifications are on. Defaults to user’s preferences.

sourcedict, optional

database_tabledict
- schemastr
  The schema name of the source table.
- tablestr
  The name of the source table.
- remote_host_idint
  The ID of the database host for the table.
- credential_idint
  The id of the credentials to be used when performing the enhancement.
- multipart_keyList[str]
  The source table primary key.

destinationdict, optional

database_tabledict
- schemastr
  The schema name for the output data.
- tablestr
  The table name for the output data.

column_mappingdict, optional

address1str
The first address line.
address2str
The second address line.
citystr
The city of an address.
statestr
The state of an address.
zipstr
The zip code of an address.
namestr
The full name of the resident at this address. If needed, separate multiple columns with +, e.g. first_name+last_name
companystr
The name of the company located at this address.

use_default_column_mappingbool, optional

Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.

perform_ncoabool, optional

Whether to update addresses for records matching the National Change of Address (NCOA) database.

ncoa_credential_idint, optional

Credential to use when performing NCOA updates. Required if ‘performNcoa’ is true.

output_levelstr, 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.

limiting_sqlstr, optional

The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).

batch_sizeint, optional

The maximum number of records processed at a time. Note that this parameter is not available to all users.

parent_idint, optional

Parent ID that triggers this enhancement.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
sourcecivis.Response
- database_tablecivis.Response
  
  schemastr
  The schema name of the source table.
  
  tablestr
  The name of the source table.
  
  remote_host_idint
  The ID of the database host for the table.
  
  credential_idint
  The id of the credentials to be used when performing the enhancement.
  
  multipart_keyList[str]
  The source table primary key.
destinationcivis.Response
- database_tablecivis.Response
  
  schemastr
  The schema name for the output data.
  
  tablestr
  The table name for the output data.
column_mappingcivis.Response
- address1str
  The first address line.
- address2str
  The second address line.
- citystr
  The city of an address.
- statestr
  The state of an address.
- zipstr
  The zip code of an address.
- namestr
  The full name of the resident at this address. If needed, separate multiple columns with +, e.g. first_name+last_name
- companystr
  The name of the company located at this address.
use_default_column_mappingbool
Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.
perform_ncoabool
Whether to update addresses for records matching the National Change of Address (NCOA) database.
ncoa_credential_idint
Credential to use when performing NCOA updates. Required if ‘performNcoa’ is true.
output_levelstr
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.
limiting_sqlstr
The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).
batch_sizeint
The maximum number of records processed at a time. Note that this parameter is not available to all users.
archivedstr
The archival status of the requested item(s).
parent_idint
Parent ID that triggers this enhancement.

patch_civis_data_match(id: int, *, name: str = None, schedule: dict = None, notifications: dict = None, input_field_mapping: dict = None, input_table: dict = None, match_target_id: int = None, output_table: dict = None, max_matches: int = None, threshold: float = None, archived: bool = None, parent_id: int = None) → Response

Update some attributes of this Civis Data Match Enhancement

Parameters:

idint

The ID for the enhancement.

namestr, optional

The name of the enhancement job.

scheduledict, optional

scheduledbool
If the item is scheduled.
scheduled_daysList[int]
Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
scheduled_hoursList[int]
Hours of the day it is scheduled on.
scheduled_minutesList[int]
Minutes of the day it is scheduled on.
scheduled_runs_per_hourint
Deprecated in favor of scheduled minutes.
scheduled_days_of_monthList[int]
Days of the month it is scheduled on, mutually exclusive with scheduledDays.

notificationsdict, optional

urlsList[str]
URLs to receive a POST request at job completion
success_email_subjectstr
Custom subject line for success e-mail.
success_email_bodystr
Custom body text for success e-mail, written in Markdown.
success_email_addressesList[str]
Addresses to notify by e-mail when the job completes successfully.
success_email_from_namestr
Name from which success emails are sent; defaults to “Civis.”
success_email_reply_tostr
Address for replies to success emails; defaults to the author of the job.
failure_email_addressesList[str]
Addresses to notify by e-mail when the job fails.
stall_warning_minutesint
Stall warning emails will be sent after this amount of minutes.
success_onbool
If success email notifications are on. Defaults to user’s preferences.
failure_onbool
If failure email notifications are on. Defaults to user’s preferences.

input_field_mappingdict, optional

The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the “phone” field), a list of column names can be provided (e.g., {“phone”: [“home_phone”, “mobile_phone”], …}).

input_tabledict, optional

database_namestr
The Redshift database name for the table.
schemastr
The schema name for the table.
tablestr
The table name.

match_target_idint, optional

The ID of the Civis Data match target. See /match_targets for IDs.

output_tabledict, optional

database_namestr
The Redshift database name for the table.
schemastr
The schema name for the table.
tablestr
The table name.

max_matchesint, optional

The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.

thresholdfloat (float), optional

The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.

archivedbool, optional

Whether the Civis Data Match Job has been archived.

parent_idint, optional

Parent ID that triggers this enhancement.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
input_field_mappingcivis.Response
The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the “phone” field), a list of column names can be provided (e.g., {“phone”: [“home_phone”, “mobile_phone”], …}).
input_tablecivis.Response
- database_namestr
  The Redshift database name for the table.
- schemastr
  The schema name for the table.
- tablestr
  The table name.
match_target_idint
The ID of the Civis Data match target. See /match_targets for IDs.
output_tablecivis.Response
- database_namestr
  The Redshift database name for the table.
- schemastr
  The schema name for the table.
- tablestr
  The table name.
max_matchesint
The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.
thresholdfloat (float)
The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.
archivedbool
Whether the Civis Data Match Job has been archived.
last_runcivis.Response
- id : int
- state : str
- created_atstr (time)
  The time that the run was queued.
- started_atstr (time)
  The time that the run started.
- finished_atstr (time)
  The time that the run completed.
- errorstr
  The error message for this run, if present.
parent_idint
Parent ID that triggers this enhancement.

patch_geocode(id: int, *, name: str = None, schedule: dict = None, notifications: dict = None, remote_host_id: int = None, credential_id: int = None, source_schema_and_table: str = None, multipart_key: List[str] = None, limiting_sql: str = None, target_schema: str = None, target_table: str = None, country: str = None, provider: str = None, output_address: bool = None, parent_id: int = None) → Response

Update some attributes of this Geocode Enhancement

Parameters:

idint

The ID for the enhancement.

namestr, optional

The name of the enhancement job.

scheduledict, optional

scheduledbool
If the item is scheduled.
scheduled_daysList[int]
Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
scheduled_hoursList[int]
Hours of the day it is scheduled on.
scheduled_minutesList[int]
Minutes of the day it is scheduled on.
scheduled_runs_per_hourint
Deprecated in favor of scheduled minutes.
scheduled_days_of_monthList[int]
Days of the month it is scheduled on, mutually exclusive with scheduledDays.

notificationsdict, optional

urlsList[str]
URLs to receive a POST request at job completion
success_email_subjectstr
Custom subject line for success e-mail.
success_email_bodystr
Custom body text for success e-mail, written in Markdown.
success_email_addressesList[str]
Addresses to notify by e-mail when the job completes successfully.
success_email_from_namestr
Name from which success emails are sent; defaults to “Civis.”
success_email_reply_tostr
Address for replies to success emails; defaults to the author of the job.
failure_email_addressesList[str]
Addresses to notify by e-mail when the job fails.
stall_warning_minutesint
Stall warning emails will be sent after this amount of minutes.
success_onbool
If success email notifications are on. Defaults to user’s preferences.
failure_onbool
If failure email notifications are on. Defaults to user’s preferences.

remote_host_idint, optional

The ID of the remote host.

credential_idint, optional

The ID of the remote host credential.

source_schema_and_tablestr, optional

The source database schema and table.

multipart_keyList[str], optional

The source table primary key.

limiting_sqlstr, optional

The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).

target_schemastr, optional

The output table schema.

target_tablestr, optional

The output table name.

countrystr, optional

The country of the addresses to be geocoded; either ‘us’ or ‘ca’.

providerstr, optional

The geocoding provider; one of postgis and geocoder_ca.

output_addressbool, optional

Whether to output the parsed address. Only guaranteed for the ‘postgis’ provider.

parent_idint, optional

Parent ID that triggers this enhancement.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
remote_host_idint
The ID of the remote host.
credential_idint
The ID of the remote host credential.
source_schema_and_tablestr
The source database schema and table.
multipart_keyList[str]
The source table primary key.
limiting_sqlstr
The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).
target_schemastr
The output table schema.
target_tablestr
The output table name.
countrystr
The country of the addresses to be geocoded; either ‘us’ or ‘ca’.
providerstr
The geocoding provider; one of postgis and geocoder_ca.
output_addressbool
Whether to output the parsed address. Only guaranteed for the ‘postgis’ provider.
archivedstr
The archival status of the requested item(s).
parent_idint
Parent ID that triggers this enhancement.

patch_identity_resolution(id: int, *, name: str = None, schedule: dict = None, notifications: dict = None, threshold: float = None, sources: List[dict] = None, match_target_id: int = None, enforced_links: List[dict] = None, customer_graph: dict = None, golden_table: dict = None, link_scores: dict = None) → Response

Update some attributes of this Identity Resolution Enhancement

Parameters:

idint

The ID for the enhancement.

namestr, optional

The name of the enhancement job.

scheduledict, optional

scheduledbool
If the item is scheduled.
scheduled_daysList[int]
Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
scheduled_hoursList[int]
Hours of the day it is scheduled on.
scheduled_minutesList[int]
Minutes of the day it is scheduled on.
scheduled_runs_per_hourint
Deprecated in favor of scheduled minutes.
scheduled_days_of_monthList[int]
Days of the month it is scheduled on, mutually exclusive with scheduledDays.

notificationsdict, optional

urlsList[str]
URLs to receive a POST request at job completion
success_email_subjectstr
Custom subject line for success e-mail.
success_email_bodystr
Custom body text for success e-mail, written in Markdown.
success_email_addressesList[str]
Addresses to notify by e-mail when the job completes successfully.
success_email_from_namestr
Name from which success emails are sent; defaults to “Civis.”
success_email_reply_tostr
Address for replies to success emails; defaults to the author of the job.
failure_email_addressesList[str]
Addresses to notify by e-mail when the job fails.
stall_warning_minutesint
Stall warning emails will be sent after this amount of minutes.
success_onbool
If success email notifications are on. Defaults to user’s preferences.
failure_onbool
If failure email notifications are on. Defaults to user’s preferences.

thresholdfloat (float), optional

A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.

sourcesList[dict], optional

The source(s) to resolve via a run of this job.

namestr
A user-specified name for the source.
descriptionstr
A description of the source.
database_namestr
The name of the source database.
schema_namestr
The name of the source schema.
table_namestr
The name of the source table.
field_mappingdict
A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix

match_target_idint, optional

The ID of the Civis Data (Custom) match target. See /match_targets for IDs.

enforced_linksList[dict], optional

A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.

source1str
Name of the first source. Must be defined in Sources list.
source1_join_colstr
Column from the first source to join on.
source2str
Name of the second source. Must be defined in Sources list
source2_join_colstr
Column from the second source to join on.

customer_graphdict, optional

database_namestr
The name of the destination database.
schema_namestr
The name of the destination schema.
table_namestr
The name of the destination table.

golden_tabledict, optional

database_namestr
The name of the destination database.
schema_namestr
The name of the destination schema.
table_namestr
The name of the destination table.
fieldsList[dict]
- field_namestr
  The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.
- rule_typestr
  One of [“automatic”, “preferred_source”]. Determines how the system will choose the value for a record. “automatic” will use the most frequent well-formatted value. “preferred_source” allows the user to prioritize values from particular sources over others.
- source_preferencesList[dict]
  Rank order for sources, when rule_type is “preferred_source”.
  
  source_namestr
  The name of the source.
  
  rankingint
  How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.

link_scoresdict, optional

database_namestr
The name of the destination database.
schema_namestr
The name of the destination schema.
table_namestr
The name of the destination table.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
archivedstr
The archival status of the requested item(s).
thresholdfloat (float)
A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.
sourcesList[civis.Response]
The source(s) to resolve via a run of this job.
- namestr
  A user-specified name for the source.
- descriptionstr
  A description of the source.
- database_namestr
  The name of the source database.
- schema_namestr
  The name of the source schema.
- table_namestr
  The name of the source table.
- field_mappingcivis.Response
  A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix
match_target_idint
The ID of the Civis Data (Custom) match target. See /match_targets for IDs.
enforced_linksList[civis.Response]
A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.
- source1str
  Name of the first source. Must be defined in Sources list.
- source1_join_colstr
  Column from the first source to join on.
- source2str
  Name of the second source. Must be defined in Sources list
- source2_join_colstr
  Column from the second source to join on.
customer_graphcivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
golden_tablecivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
- fieldsList[civis.Response]
  
  field_namestr
  The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.
  
  rule_typestr
  One of [“automatic”, “preferred_source”]. Determines how the system will choose the value for a record. “automatic” will use the most frequent well-formatted value. “preferred_source” allows the user to prioritize values from particular sources over others.
  
  source_preferencesList[civis.Response]
  Rank order for sources, when rule_type is “preferred_source”.
  
  source_namestr
  The name of the source.
  
  rankingint
  How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.
link_scorescivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
legacy_idint
ID of this pipeline in the legacy IDR service application.
last_runcivis.Response
- id : int
- state : str
- created_atstr (time)
  The time that the run was queued.
- started_atstr (time)
  The time that the run started.
- finished_atstr (time)
  The time that the run completed.
- errorstr
  The error message for this run, if present.
- configstr
  How the Identity Resolution job was configured for this run.
- sample_records_querystr
  A SQL query to produce a sample of records to inspect.
- expand_cluster_querystr
  A customizable query to view PII associated with resolved ids.
- run_metricscivis.Response
  
  num_recordsint
  The number of input records for this run.
  
  unique_idsint
  The number of distinct unique IDs in the input records for this run.
  
  unique_deduplicated_idsint
  The number of resolved IDs associated with more than one unique ID in the input.
  
  max_cluster_sizeint
  The number of records in the largest cluster of resolved IDs.
  
  avg_cluster_sizefloat (float)
  The average number of records with the same resolved ID.
  
  cluster_size_frequenciescivis.Response
  A mapping from numbers of records with the same resolved ID (i.e., sizes of clusters) to numbers of such clusters. For example, if there were 10 clusters with 2 records each, 2 would be a key in the mapping, and 10 would be its value.
- error_sectionstr
  If there was a failure, this will denote which section of the Identity Resolution job failed. One of: data_preparation, compute_setup or data_processing.

post_cass_ncoa(name: str, source: dict, *, schedule: dict = None, notifications: dict = None, destination: dict = None, column_mapping: dict = None, use_default_column_mapping: bool = None, perform_ncoa: bool = None, ncoa_credential_id: int = None, output_level: str = None, limiting_sql: str = None, batch_size: int = None, parent_id: int = None) → Response

Create a CASS/NCOA Enhancement

Parameters:

namestr

The name of the enhancement job.

sourcedict

database_tabledict
- schemastr
  The schema name of the source table.
- tablestr
  The name of the source table.
- remote_host_idint
  The ID of the database host for the table.
- credential_idint
  The id of the credentials to be used when performing the enhancement.
- multipart_keyList[str]
  The source table primary key.

scheduledict, optional

scheduledbool
If the item is scheduled.
scheduled_daysList[int]
Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
scheduled_hoursList[int]
Hours of the day it is scheduled on.
scheduled_minutesList[int]
Minutes of the day it is scheduled on.
scheduled_runs_per_hourint
Deprecated in favor of scheduled minutes.
scheduled_days_of_monthList[int]
Days of the month it is scheduled on, mutually exclusive with scheduledDays.

notificationsdict, optional

urlsList[str]
URLs to receive a POST request at job completion
success_email_subjectstr
Custom subject line for success e-mail.
success_email_bodystr
Custom body text for success e-mail, written in Markdown.
success_email_addressesList[str]
Addresses to notify by e-mail when the job completes successfully.
success_email_from_namestr
Name from which success emails are sent; defaults to “Civis.”
success_email_reply_tostr
Address for replies to success emails; defaults to the author of the job.
failure_email_addressesList[str]
Addresses to notify by e-mail when the job fails.
stall_warning_minutesint
Stall warning emails will be sent after this amount of minutes.
success_onbool
If success email notifications are on. Defaults to user’s preferences.
failure_onbool
If failure email notifications are on. Defaults to user’s preferences.

destinationdict, optional

database_tabledict
- schemastr
  The schema name for the output data.
- tablestr
  The table name for the output data.

column_mappingdict, optional

address1str
The first address line.
address2str
The second address line.
citystr
The city of an address.
statestr
The state of an address.
zipstr
The zip code of an address.
namestr
The full name of the resident at this address. If needed, separate multiple columns with +, e.g. first_name+last_name
companystr
The name of the company located at this address.

use_default_column_mappingbool, optional

Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.

perform_ncoabool, optional

Whether to update addresses for records matching the National Change of Address (NCOA) database.

ncoa_credential_idint, optional

Credential to use when performing NCOA updates. Required if ‘performNcoa’ is true.

output_levelstr, 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.

limiting_sqlstr, optional

The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).

batch_sizeint, optional

The maximum number of records processed at a time. Note that this parameter is not available to all users.

parent_idint, optional

Parent ID that triggers this enhancement.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
sourcecivis.Response
- database_tablecivis.Response
  
  schemastr
  The schema name of the source table.
  
  tablestr
  The name of the source table.
  
  remote_host_idint
  The ID of the database host for the table.
  
  credential_idint
  The id of the credentials to be used when performing the enhancement.
  
  multipart_keyList[str]
  The source table primary key.
destinationcivis.Response
- database_tablecivis.Response
  
  schemastr
  The schema name for the output data.
  
  tablestr
  The table name for the output data.
column_mappingcivis.Response
- address1str
  The first address line.
- address2str
  The second address line.
- citystr
  The city of an address.
- statestr
  The state of an address.
- zipstr
  The zip code of an address.
- namestr
  The full name of the resident at this address. If needed, separate multiple columns with +, e.g. first_name+last_name
- companystr
  The name of the company located at this address.
use_default_column_mappingbool
Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.
perform_ncoabool
Whether to update addresses for records matching the National Change of Address (NCOA) database.
ncoa_credential_idint
Credential to use when performing NCOA updates. Required if ‘performNcoa’ is true.
output_levelstr
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.
limiting_sqlstr
The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).
batch_sizeint
The maximum number of records processed at a time. Note that this parameter is not available to all users.
archivedstr
The archival status of the requested item(s).
parent_idint
Parent ID that triggers this enhancement.

post_cass_ncoa_cancel(id: int) → Response

Cancel a run

Parameters:

idint: The ID of the job.

Returns:

civis.Response

idint
The ID of the run.
statestr
The state of the run, one of ‘queued’, ‘running’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.

post_cass_ncoa_runs(id: int) → Response

Start a run

Parameters:

idint: The ID of the CASS NCOA job.

Returns:

civis.Response

idint
The ID of the run.
cass_ncoa_idint
The ID of the CASS NCOA job.
statestr
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.
created_atstr (time)
The time the run was created.
started_atstr (time)
The time the run started at.
finished_atstr (time)
The time the run completed.
errorstr
The error, if any, returned by the run.

post_civis_data_match(name: str, input_field_mapping: dict, input_table: dict, match_target_id: int, output_table: dict, *, schedule: dict = None, notifications: dict = None, max_matches: int = None, threshold: float = None, archived: bool = None, parent_id: int = None) → Response

Create a Civis Data Match Enhancement

Parameters:

namestr

The name of the enhancement job.

input_field_mappingdict

The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the “phone” field), a list of column names can be provided (e.g., {“phone”: [“home_phone”, “mobile_phone”], …}).

input_tabledict

database_namestr
The Redshift database name for the table.
schemastr
The schema name for the table.
tablestr
The table name.

match_target_idint

The ID of the Civis Data match target. See /match_targets for IDs.

output_tabledict

database_namestr
The Redshift database name for the table.
schemastr
The schema name for the table.
tablestr
The table name.

scheduledict, optional

scheduledbool
If the item is scheduled.
scheduled_daysList[int]
Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
scheduled_hoursList[int]
Hours of the day it is scheduled on.
scheduled_minutesList[int]
Minutes of the day it is scheduled on.
scheduled_runs_per_hourint
Deprecated in favor of scheduled minutes.
scheduled_days_of_monthList[int]
Days of the month it is scheduled on, mutually exclusive with scheduledDays.

notificationsdict, optional

urlsList[str]
URLs to receive a POST request at job completion
success_email_subjectstr
Custom subject line for success e-mail.
success_email_bodystr
Custom body text for success e-mail, written in Markdown.
success_email_addressesList[str]
Addresses to notify by e-mail when the job completes successfully.
success_email_from_namestr
Name from which success emails are sent; defaults to “Civis.”
success_email_reply_tostr
Address for replies to success emails; defaults to the author of the job.
failure_email_addressesList[str]
Addresses to notify by e-mail when the job fails.
stall_warning_minutesint
Stall warning emails will be sent after this amount of minutes.
success_onbool
If success email notifications are on. Defaults to user’s preferences.
failure_onbool
If failure email notifications are on. Defaults to user’s preferences.

max_matchesint, optional

The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.

thresholdfloat (float), optional

The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.

archivedbool, optional

Whether the Civis Data Match Job has been archived.

parent_idint, optional

Parent ID that triggers this enhancement.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
input_field_mappingcivis.Response
The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the “phone” field), a list of column names can be provided (e.g., {“phone”: [“home_phone”, “mobile_phone”], …}).
input_tablecivis.Response
- database_namestr
  The Redshift database name for the table.
- schemastr
  The schema name for the table.
- tablestr
  The table name.
match_target_idint
The ID of the Civis Data match target. See /match_targets for IDs.
output_tablecivis.Response
- database_namestr
  The Redshift database name for the table.
- schemastr
  The schema name for the table.
- tablestr
  The table name.
max_matchesint
The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.
thresholdfloat (float)
The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.
archivedbool
Whether the Civis Data Match Job has been archived.
last_runcivis.Response
- id : int
- state : str
- created_atstr (time)
  The time that the run was queued.
- started_atstr (time)
  The time that the run started.
- finished_atstr (time)
  The time that the run completed.
- errorstr
  The error message for this run, if present.
parent_idint
Parent ID that triggers this enhancement.

post_civis_data_match_cancel(id: int) → Response

Cancel a run

Parameters:

idint: The ID of the job.

Returns:

civis.Response

idint
The ID of the run.
statestr
The state of the run, one of ‘queued’, ‘running’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.

post_civis_data_match_clone(id: int, *, clone_schedule: bool = None, clone_triggers: bool = None, clone_notifications: bool = None) → Response

Clone this Civis Data Match Enhancement

Parameters:

idint: The ID for the enhancement.
clone_schedulebool, optional: If true, also copy the schedule to the new enhancement.
clone_triggersbool, optional: If true, also copy the triggers to the new enhancement.
clone_notificationsbool, optional: If true, also copy the notifications to the new enhancement.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
input_field_mappingcivis.Response
The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the “phone” field), a list of column names can be provided (e.g., {“phone”: [“home_phone”, “mobile_phone”], …}).
input_tablecivis.Response
- database_namestr
  The Redshift database name for the table.
- schemastr
  The schema name for the table.
- tablestr
  The table name.
match_target_idint
The ID of the Civis Data match target. See /match_targets for IDs.
output_tablecivis.Response
- database_namestr
  The Redshift database name for the table.
- schemastr
  The schema name for the table.
- tablestr
  The table name.
max_matchesint
The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.
thresholdfloat (float)
The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.
archivedbool
Whether the Civis Data Match Job has been archived.
last_runcivis.Response
- id : int
- state : str
- created_atstr (time)
  The time that the run was queued.
- started_atstr (time)
  The time that the run started.
- finished_atstr (time)
  The time that the run completed.
- errorstr
  The error message for this run, if present.
parent_idint
Parent ID that triggers this enhancement.

post_civis_data_match_runs(id: int) → Response

Start a run

Parameters:

idint: The ID of the Civis Data Match job.

Returns:

civis.Response

idint
The ID of the run.
civis_data_match_idint
The ID of the Civis Data Match job.
statestr
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.
created_atstr (time)
The time the run was created.
started_atstr (time)
The time the run started at.
finished_atstr (time)
The time the run completed.
errorstr
The error, if any, returned by the run.

post_geocode(name: str, remote_host_id: int, credential_id: int, source_schema_and_table: str, *, schedule: dict = None, notifications: dict = None, multipart_key: List[str] = None, limiting_sql: str = None, target_schema: str = None, target_table: str = None, country: str = None, provider: str = None, output_address: bool = None, parent_id: int = None) → Response

Create a Geocode Enhancement

Parameters:

namestr

The name of the enhancement job.

remote_host_idint

The ID of the remote host.

credential_idint

The ID of the remote host credential.

source_schema_and_tablestr

The source database schema and table.

scheduledict, optional

scheduledbool
If the item is scheduled.
scheduled_daysList[int]
Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
scheduled_hoursList[int]
Hours of the day it is scheduled on.
scheduled_minutesList[int]
Minutes of the day it is scheduled on.
scheduled_runs_per_hourint
Deprecated in favor of scheduled minutes.
scheduled_days_of_monthList[int]
Days of the month it is scheduled on, mutually exclusive with scheduledDays.

notificationsdict, optional

urlsList[str]
URLs to receive a POST request at job completion
success_email_subjectstr
Custom subject line for success e-mail.
success_email_bodystr
Custom body text for success e-mail, written in Markdown.
success_email_addressesList[str]
Addresses to notify by e-mail when the job completes successfully.
success_email_from_namestr
Name from which success emails are sent; defaults to “Civis.”
success_email_reply_tostr
Address for replies to success emails; defaults to the author of the job.
failure_email_addressesList[str]
Addresses to notify by e-mail when the job fails.
stall_warning_minutesint
Stall warning emails will be sent after this amount of minutes.
success_onbool
If success email notifications are on. Defaults to user’s preferences.
failure_onbool
If failure email notifications are on. Defaults to user’s preferences.

multipart_keyList[str], optional

The source table primary key.

limiting_sqlstr, optional

The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).

target_schemastr, optional

The output table schema.

target_tablestr, optional

The output table name.

countrystr, optional

The country of the addresses to be geocoded; either ‘us’ or ‘ca’.

providerstr, optional

The geocoding provider; one of postgis and geocoder_ca.

output_addressbool, optional

Whether to output the parsed address. Only guaranteed for the ‘postgis’ provider.

parent_idint, optional

Parent ID that triggers this enhancement.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
remote_host_idint
The ID of the remote host.
credential_idint
The ID of the remote host credential.
source_schema_and_tablestr
The source database schema and table.
multipart_keyList[str]
The source table primary key.
limiting_sqlstr
The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).
target_schemastr
The output table schema.
target_tablestr
The output table name.
countrystr
The country of the addresses to be geocoded; either ‘us’ or ‘ca’.
providerstr
The geocoding provider; one of postgis and geocoder_ca.
output_addressbool
Whether to output the parsed address. Only guaranteed for the ‘postgis’ provider.
archivedstr
The archival status of the requested item(s).
parent_idint
Parent ID that triggers this enhancement.

post_geocode_cancel(id: int) → Response

Cancel a run

Parameters:

idint: The ID of the job.

Returns:

civis.Response

idint
The ID of the run.
statestr
The state of the run, one of ‘queued’, ‘running’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.

post_geocode_runs(id: int) → Response

Start a run

Parameters:

idint: The ID of the Geocode job.

Returns:

civis.Response

idint
The ID of the run.
geocode_idint
The ID of the Geocode job.
statestr
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.
created_atstr (time)
The time the run was created.
started_atstr (time)
The time the run started at.
finished_atstr (time)
The time the run completed.
errorstr
The error, if any, returned by the run.

post_identity_resolution(name: str, sources: List[dict], *, schedule: dict = None, notifications: dict = None, threshold: float = None, match_target_id: int = None, enforced_links: List[dict] = None, customer_graph: dict = None, golden_table: dict = None, link_scores: dict = None, legacy_id: int = None) → Response

Create an Identity Resolution Enhancement

Parameters:

namestr

The name of the enhancement job.

sourcesList[dict]

The source(s) to resolve via a run of this job.

namestr
A user-specified name for the source.
descriptionstr
A description of the source.
database_namestr
The name of the source database.
schema_namestr
The name of the source schema.
table_namestr
The name of the source table.
field_mappingdict
A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix

scheduledict, optional

scheduledbool
If the item is scheduled.
scheduled_daysList[int]
Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
scheduled_hoursList[int]
Hours of the day it is scheduled on.
scheduled_minutesList[int]
Minutes of the day it is scheduled on.
scheduled_runs_per_hourint
Deprecated in favor of scheduled minutes.
scheduled_days_of_monthList[int]
Days of the month it is scheduled on, mutually exclusive with scheduledDays.

notificationsdict, optional

urlsList[str]
URLs to receive a POST request at job completion
success_email_subjectstr
Custom subject line for success e-mail.
success_email_bodystr
Custom body text for success e-mail, written in Markdown.
success_email_addressesList[str]
Addresses to notify by e-mail when the job completes successfully.
success_email_from_namestr
Name from which success emails are sent; defaults to “Civis.”
success_email_reply_tostr
Address for replies to success emails; defaults to the author of the job.
failure_email_addressesList[str]
Addresses to notify by e-mail when the job fails.
stall_warning_minutesint
Stall warning emails will be sent after this amount of minutes.
success_onbool
If success email notifications are on. Defaults to user’s preferences.
failure_onbool
If failure email notifications are on. Defaults to user’s preferences.

thresholdfloat (float), optional

A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.

match_target_idint, optional

The ID of the Civis Data (Custom) match target. See /match_targets for IDs.

enforced_linksList[dict], optional

A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.

source1str
Name of the first source. Must be defined in Sources list.
source1_join_colstr
Column from the first source to join on.
source2str
Name of the second source. Must be defined in Sources list
source2_join_colstr
Column from the second source to join on.

customer_graphdict, optional

database_namestr
The name of the destination database.
schema_namestr
The name of the destination schema.
table_namestr
The name of the destination table.

golden_tabledict, optional

database_namestr
The name of the destination database.
schema_namestr
The name of the destination schema.
table_namestr
The name of the destination table.
fieldsList[dict]
- field_namestr
  The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.
- rule_typestr
  One of [“automatic”, “preferred_source”]. Determines how the system will choose the value for a record. “automatic” will use the most frequent well-formatted value. “preferred_source” allows the user to prioritize values from particular sources over others.
- source_preferencesList[dict]
  Rank order for sources, when rule_type is “preferred_source”.
  
  source_namestr
  The name of the source.
  
  rankingint
  How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.

link_scoresdict, optional

database_namestr
The name of the destination database.
schema_namestr
The name of the destination schema.
table_namestr
The name of the destination table.

legacy_idint, optional

ID of this pipeline in the legacy IDR service application.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
archivedstr
The archival status of the requested item(s).
thresholdfloat (float)
A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.
sourcesList[civis.Response]
The source(s) to resolve via a run of this job.
- namestr
  A user-specified name for the source.
- descriptionstr
  A description of the source.
- database_namestr
  The name of the source database.
- schema_namestr
  The name of the source schema.
- table_namestr
  The name of the source table.
- field_mappingcivis.Response
  A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix
match_target_idint
The ID of the Civis Data (Custom) match target. See /match_targets for IDs.
enforced_linksList[civis.Response]
A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.
- source1str
  Name of the first source. Must be defined in Sources list.
- source1_join_colstr
  Column from the first source to join on.
- source2str
  Name of the second source. Must be defined in Sources list
- source2_join_colstr
  Column from the second source to join on.
customer_graphcivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
golden_tablecivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
- fieldsList[civis.Response]
  
  field_namestr
  The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.
  
  rule_typestr
  One of [“automatic”, “preferred_source”]. Determines how the system will choose the value for a record. “automatic” will use the most frequent well-formatted value. “preferred_source” allows the user to prioritize values from particular sources over others.
  
  source_preferencesList[civis.Response]
  Rank order for sources, when rule_type is “preferred_source”.
  
  source_namestr
  The name of the source.
  
  rankingint
  How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.
link_scorescivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
legacy_idint
ID of this pipeline in the legacy IDR service application.
last_runcivis.Response
- id : int
- state : str
- created_atstr (time)
  The time that the run was queued.
- started_atstr (time)
  The time that the run started.
- finished_atstr (time)
  The time that the run completed.
- errorstr
  The error message for this run, if present.
- configstr
  How the Identity Resolution job was configured for this run.
- sample_records_querystr
  A SQL query to produce a sample of records to inspect.
- expand_cluster_querystr
  A customizable query to view PII associated with resolved ids.
- run_metricscivis.Response
  
  num_recordsint
  The number of input records for this run.
  
  unique_idsint
  The number of distinct unique IDs in the input records for this run.
  
  unique_deduplicated_idsint
  The number of resolved IDs associated with more than one unique ID in the input.
  
  max_cluster_sizeint
  The number of records in the largest cluster of resolved IDs.
  
  avg_cluster_sizefloat (float)
  The average number of records with the same resolved ID.
  
  cluster_size_frequenciescivis.Response
  A mapping from numbers of records with the same resolved ID (i.e., sizes of clusters) to numbers of such clusters. For example, if there were 10 clusters with 2 records each, 2 would be a key in the mapping, and 10 would be its value.
- error_sectionstr
  If there was a failure, this will denote which section of the Identity Resolution job failed. One of: data_preparation, compute_setup or data_processing.

post_identity_resolution_cancel(id: int) → Response

Cancel a run

Parameters:

idint: The ID of the job.

Returns:

civis.Response

idint
The ID of the run.
statestr
The state of the run, one of ‘queued’, ‘running’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.

post_identity_resolution_clone(id: int, *, clone_schedule: bool = None, clone_triggers: bool = None, clone_notifications: bool = None) → Response

Clone this Identity Resolution Enhancement

Parameters:

idint: The ID for the enhancement.
clone_schedulebool, optional: If true, also copy the schedule to the new enhancement.
clone_triggersbool, optional: If true, also copy the triggers to the new enhancement.
clone_notificationsbool, optional: If true, also copy the notifications to the new enhancement.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
archivedstr
The archival status of the requested item(s).
thresholdfloat (float)
A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.
sourcesList[civis.Response]
The source(s) to resolve via a run of this job.
- namestr
  A user-specified name for the source.
- descriptionstr
  A description of the source.
- database_namestr
  The name of the source database.
- schema_namestr
  The name of the source schema.
- table_namestr
  The name of the source table.
- field_mappingcivis.Response
  A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix
match_target_idint
The ID of the Civis Data (Custom) match target. See /match_targets for IDs.
enforced_linksList[civis.Response]
A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.
- source1str
  Name of the first source. Must be defined in Sources list.
- source1_join_colstr
  Column from the first source to join on.
- source2str
  Name of the second source. Must be defined in Sources list
- source2_join_colstr
  Column from the second source to join on.
customer_graphcivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
golden_tablecivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
- fieldsList[civis.Response]
  
  field_namestr
  The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.
  
  rule_typestr
  One of [“automatic”, “preferred_source”]. Determines how the system will choose the value for a record. “automatic” will use the most frequent well-formatted value. “preferred_source” allows the user to prioritize values from particular sources over others.
  
  source_preferencesList[civis.Response]
  Rank order for sources, when rule_type is “preferred_source”.
  
  source_namestr
  The name of the source.
  
  rankingint
  How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.
link_scorescivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
legacy_idint
ID of this pipeline in the legacy IDR service application.
last_runcivis.Response
- id : int
- state : str
- created_atstr (time)
  The time that the run was queued.
- started_atstr (time)
  The time that the run started.
- finished_atstr (time)
  The time that the run completed.
- errorstr
  The error message for this run, if present.
- configstr
  How the Identity Resolution job was configured for this run.
- sample_records_querystr
  A SQL query to produce a sample of records to inspect.
- expand_cluster_querystr
  A customizable query to view PII associated with resolved ids.
- run_metricscivis.Response
  
  num_recordsint
  The number of input records for this run.
  
  unique_idsint
  The number of distinct unique IDs in the input records for this run.
  
  unique_deduplicated_idsint
  The number of resolved IDs associated with more than one unique ID in the input.
  
  max_cluster_sizeint
  The number of records in the largest cluster of resolved IDs.
  
  avg_cluster_sizefloat (float)
  The average number of records with the same resolved ID.
  
  cluster_size_frequenciescivis.Response
  A mapping from numbers of records with the same resolved ID (i.e., sizes of clusters) to numbers of such clusters. For example, if there were 10 clusters with 2 records each, 2 would be a key in the mapping, and 10 would be its value.
- error_sectionstr
  If there was a failure, this will denote which section of the Identity Resolution job failed. One of: data_preparation, compute_setup or data_processing.

post_identity_resolution_runs(id: int) → Response

Start a run

Parameters:

idint: The ID of the Identity Resolution job.

Returns:

civis.Response

idint
The ID of the run.
identity_resolution_idint
The ID of the Identity Resolution job.
statestr
The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
is_cancel_requestedbool
True if run cancel requested, else false.
created_atstr (time)
The time the run was created.
started_atstr (time)
The time the run started at.
finished_atstr (time)
The time the run completed.
errorstr
The error, if any, returned by the run.
configstr
How the Identity Resolution job was configured for this run.
sample_records_querystr
A SQL query to produce a sample of records to inspect.
expand_cluster_querystr
A customizable query to view PII associated with resolved ids.
run_metricscivis.Response
- num_recordsint
  The number of input records for this run.
- unique_idsint
  The number of distinct unique IDs in the input records for this run.
- unique_deduplicated_idsint
  The number of resolved IDs associated with more than one unique ID in the input.
- max_cluster_sizeint
  The number of records in the largest cluster of resolved IDs.
- avg_cluster_sizefloat (float)
  The average number of records with the same resolved ID.
- cluster_size_frequenciescivis.Response
  A mapping from numbers of records with the same resolved ID (i.e., sizes of clusters) to numbers of such clusters. For example, if there were 10 clusters with 2 records each, 2 would be a key in the mapping, and 10 would be its value.
error_sectionstr
If there was a failure, this will denote which section of the Identity Resolution job failed. One of: data_preparation, compute_setup or data_processing.

put_cass_ncoa(id: int, name: str, source: dict, *, schedule: dict = None, notifications: dict = None, destination: dict = None, column_mapping: dict = None, use_default_column_mapping: bool = None, perform_ncoa: bool = None, ncoa_credential_id: int = None, output_level: str = None, limiting_sql: str = None, batch_size: int = None, parent_id: int = None) → Response

Replace all attributes of this CASS/NCOA Enhancement

Parameters:

idint

The ID for the enhancement.

namestr

The name of the enhancement job.

sourcedict

database_tabledict
- schemastr
  The schema name of the source table.
- tablestr
  The name of the source table.
- remote_host_idint
  The ID of the database host for the table.
- credential_idint
  The id of the credentials to be used when performing the enhancement.
- multipart_keyList[str]
  The source table primary key.

scheduledict, optional

scheduledbool
If the item is scheduled.
scheduled_daysList[int]
Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
scheduled_hoursList[int]
Hours of the day it is scheduled on.
scheduled_minutesList[int]
Minutes of the day it is scheduled on.
scheduled_runs_per_hourint
Deprecated in favor of scheduled minutes.
scheduled_days_of_monthList[int]
Days of the month it is scheduled on, mutually exclusive with scheduledDays.

notificationsdict, optional

urlsList[str]
URLs to receive a POST request at job completion
success_email_subjectstr
Custom subject line for success e-mail.
success_email_bodystr
Custom body text for success e-mail, written in Markdown.
success_email_addressesList[str]
Addresses to notify by e-mail when the job completes successfully.
success_email_from_namestr
Name from which success emails are sent; defaults to “Civis.”
success_email_reply_tostr
Address for replies to success emails; defaults to the author of the job.
failure_email_addressesList[str]
Addresses to notify by e-mail when the job fails.
stall_warning_minutesint
Stall warning emails will be sent after this amount of minutes.
success_onbool
If success email notifications are on. Defaults to user’s preferences.
failure_onbool
If failure email notifications are on. Defaults to user’s preferences.

destinationdict, optional

database_tabledict
- schemastr
  The schema name for the output data.
- tablestr
  The table name for the output data.

column_mappingdict, optional

address1str
The first address line.
address2str
The second address line.
citystr
The city of an address.
statestr
The state of an address.
zipstr
The zip code of an address.
namestr
The full name of the resident at this address. If needed, separate multiple columns with +, e.g. first_name+last_name
companystr
The name of the company located at this address.

use_default_column_mappingbool, optional

Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.

perform_ncoabool, optional

Whether to update addresses for records matching the National Change of Address (NCOA) database.

ncoa_credential_idint, optional

Credential to use when performing NCOA updates. Required if ‘performNcoa’ is true.

output_levelstr, 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.

limiting_sqlstr, optional

The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).

batch_sizeint, optional

The maximum number of records processed at a time. Note that this parameter is not available to all users.

parent_idint, optional

Parent ID that triggers this enhancement.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
sourcecivis.Response
- database_tablecivis.Response
  
  schemastr
  The schema name of the source table.
  
  tablestr
  The name of the source table.
  
  remote_host_idint
  The ID of the database host for the table.
  
  credential_idint
  The id of the credentials to be used when performing the enhancement.
  
  multipart_keyList[str]
  The source table primary key.
destinationcivis.Response
- database_tablecivis.Response
  
  schemastr
  The schema name for the output data.
  
  tablestr
  The table name for the output data.
column_mappingcivis.Response
- address1str
  The first address line.
- address2str
  The second address line.
- citystr
  The city of an address.
- statestr
  The state of an address.
- zipstr
  The zip code of an address.
- namestr
  The full name of the resident at this address. If needed, separate multiple columns with +, e.g. first_name+last_name
- companystr
  The name of the company located at this address.
use_default_column_mappingbool
Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.
perform_ncoabool
Whether to update addresses for records matching the National Change of Address (NCOA) database.
ncoa_credential_idint
Credential to use when performing NCOA updates. Required if ‘performNcoa’ is true.
output_levelstr
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.
limiting_sqlstr
The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).
batch_sizeint
The maximum number of records processed at a time. Note that this parameter is not available to all users.
archivedstr
The archival status of the requested item(s).
parent_idint
Parent ID that triggers this enhancement.

put_cass_ncoa_archive(id: int, status: bool) → Response

Update the archive status of this object

Parameters:

idint: The ID of the object.
statusbool: The desired archived status of the object.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
sourcecivis.Response
- database_tablecivis.Response
  
  schemastr
  The schema name of the source table.
  
  tablestr
  The name of the source table.
  
  remote_host_idint
  The ID of the database host for the table.
  
  credential_idint
  The id of the credentials to be used when performing the enhancement.
  
  multipart_keyList[str]
  The source table primary key.
destinationcivis.Response
- database_tablecivis.Response
  
  schemastr
  The schema name for the output data.
  
  tablestr
  The table name for the output data.
column_mappingcivis.Response
- address1str
  The first address line.
- address2str
  The second address line.
- citystr
  The city of an address.
- statestr
  The state of an address.
- zipstr
  The zip code of an address.
- namestr
  The full name of the resident at this address. If needed, separate multiple columns with +, e.g. first_name+last_name
- companystr
  The name of the company located at this address.
use_default_column_mappingbool
Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.
perform_ncoabool
Whether to update addresses for records matching the National Change of Address (NCOA) database.
ncoa_credential_idint
Credential to use when performing NCOA updates. Required if ‘performNcoa’ is true.
output_levelstr
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.
limiting_sqlstr
The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).
batch_sizeint
The maximum number of records processed at a time. Note that this parameter is not available to all users.
archivedstr
The archival status of the requested item(s).
parent_idint
Parent ID that triggers this enhancement.

put_cass_ncoa_projects(id: int, project_id: int) → Response

Add a CASS/NCOA Enhancement to a project

Parameters:

idint: The ID of the CASS/NCOA Enhancement.
project_idint: The ID of the project.

Returns:

None: Response code 204: success

put_cass_ncoa_shares_groups(id: int, group_ids: List[int], permission_level: str, *, share_email_body: str = None, send_shared_email: bool = None) → Response

Set the permissions groups has on this object

Parameters:

idint: The ID of the resource that is shared.
group_idsList[int]: An array of one or more group IDs.
permission_levelstr: Options are: “read”, “write”, or “manage”.
share_email_bodystr, optional: Custom body text for e-mail sent on a share.
send_shared_emailbool, optional: Send email to the recipients of a share.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

put_cass_ncoa_shares_users(id: int, user_ids: List[int], permission_level: str, *, share_email_body: str = None, send_shared_email: bool = None) → Response

Set the permissions users have on this object

Parameters:

idint: The ID of the resource that is shared.
user_idsList[int]: An array of one or more user IDs.
permission_levelstr: Options are: “read”, “write”, or “manage”.
share_email_bodystr, optional: Custom body text for e-mail sent on a share.
send_shared_emailbool, optional: Send email to the recipients of a share.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

put_cass_ncoa_transfer(id: int, user_id: int, include_dependencies: bool, *, email_body: str = None, send_email: bool = None) → Response

Transfer ownership of this object to another user

Parameters:

idint: The ID of the resource that is shared.
user_idint: ID of target user
include_dependenciesbool: Whether or not to give manage permissions on all dependencies
email_bodystr, optional: Custom body text for e-mail sent on transfer.
send_emailbool, optional: Send email to the target user of the transfer?

Returns:

civis.Response

dependenciesList[civis.Response]
Dependent objects for this object
- object_typestr
  Dependent object type
- fco_typestr
  Human readable dependent object type
- idint
  Dependent object ID
- namestr
  Dependent object name, or nil if the requesting user cannot read this object
- permission_levelstr
  Permission level of target user (not user’s groups) for dependent object. Null if no target user or not shareable (e.g. a database table).
- descriptionstr
  Additional information about the dependency, if relevant
- sharedbool
  Whether dependent object was successfully shared with target user

put_civis_data_match(id: int, name: str, input_field_mapping: dict, input_table: dict, match_target_id: int, output_table: dict, *, schedule: dict = None, notifications: dict = None, max_matches: int = None, threshold: float = None, archived: bool = None, parent_id: int = None) → Response

Replace all attributes of this Civis Data Match Enhancement

Parameters:

idint

The ID for the enhancement.

namestr

The name of the enhancement job.

input_field_mappingdict

The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the “phone” field), a list of column names can be provided (e.g., {“phone”: [“home_phone”, “mobile_phone”], …}).

input_tabledict

database_namestr
The Redshift database name for the table.
schemastr
The schema name for the table.
tablestr
The table name.

match_target_idint

The ID of the Civis Data match target. See /match_targets for IDs.

output_tabledict

database_namestr
The Redshift database name for the table.
schemastr
The schema name for the table.
tablestr
The table name.

scheduledict, optional

scheduledbool
If the item is scheduled.
scheduled_daysList[int]
Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
scheduled_hoursList[int]
Hours of the day it is scheduled on.
scheduled_minutesList[int]
Minutes of the day it is scheduled on.
scheduled_runs_per_hourint
Deprecated in favor of scheduled minutes.
scheduled_days_of_monthList[int]
Days of the month it is scheduled on, mutually exclusive with scheduledDays.

notificationsdict, optional

urlsList[str]
URLs to receive a POST request at job completion
success_email_subjectstr
Custom subject line for success e-mail.
success_email_bodystr
Custom body text for success e-mail, written in Markdown.
success_email_addressesList[str]
Addresses to notify by e-mail when the job completes successfully.
success_email_from_namestr
Name from which success emails are sent; defaults to “Civis.”
success_email_reply_tostr
Address for replies to success emails; defaults to the author of the job.
failure_email_addressesList[str]
Addresses to notify by e-mail when the job fails.
stall_warning_minutesint
Stall warning emails will be sent after this amount of minutes.
success_onbool
If success email notifications are on. Defaults to user’s preferences.
failure_onbool
If failure email notifications are on. Defaults to user’s preferences.

max_matchesint, optional

The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.

thresholdfloat (float), optional

The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.

archivedbool, optional

Whether the Civis Data Match Job has been archived.

parent_idint, optional

Parent ID that triggers this enhancement.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
input_field_mappingcivis.Response
The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the “phone” field), a list of column names can be provided (e.g., {“phone”: [“home_phone”, “mobile_phone”], …}).
input_tablecivis.Response
- database_namestr
  The Redshift database name for the table.
- schemastr
  The schema name for the table.
- tablestr
  The table name.
match_target_idint
The ID of the Civis Data match target. See /match_targets for IDs.
output_tablecivis.Response
- database_namestr
  The Redshift database name for the table.
- schemastr
  The schema name for the table.
- tablestr
  The table name.
max_matchesint
The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.
thresholdfloat (float)
The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.
archivedbool
Whether the Civis Data Match Job has been archived.
last_runcivis.Response
- id : int
- state : str
- created_atstr (time)
  The time that the run was queued.
- started_atstr (time)
  The time that the run started.
- finished_atstr (time)
  The time that the run completed.
- errorstr
  The error message for this run, if present.
parent_idint
Parent ID that triggers this enhancement.

put_civis_data_match_archive(id: int, status: bool) → Response

Update the archive status of this object

Parameters:

idint: The ID of the object.
statusbool: The desired archived status of the object.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
input_field_mappingcivis.Response
The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the “phone” field), a list of column names can be provided (e.g., {“phone”: [“home_phone”, “mobile_phone”], …}).
input_tablecivis.Response
- database_namestr
  The Redshift database name for the table.
- schemastr
  The schema name for the table.
- tablestr
  The table name.
match_target_idint
The ID of the Civis Data match target. See /match_targets for IDs.
output_tablecivis.Response
- database_namestr
  The Redshift database name for the table.
- schemastr
  The schema name for the table.
- tablestr
  The table name.
max_matchesint
The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.
thresholdfloat (float)
The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.
archivedbool
Whether the Civis Data Match Job has been archived.
last_runcivis.Response
- id : int
- state : str
- created_atstr (time)
  The time that the run was queued.
- started_atstr (time)
  The time that the run started.
- finished_atstr (time)
  The time that the run completed.
- errorstr
  The error message for this run, if present.
parent_idint
Parent ID that triggers this enhancement.

put_civis_data_match_projects(id: int, project_id: int) → Response

Add a Civis Data Match Enhancement to a project

Parameters:

idint: The ID of the Civis Data Match Enhancement.
project_idint: The ID of the project.

Returns:

None: Response code 204: success

put_civis_data_match_shares_groups(id: int, group_ids: List[int], permission_level: str, *, share_email_body: str = None, send_shared_email: bool = None) → Response

Set the permissions groups has on this object

Parameters:

idint: The ID of the resource that is shared.
group_idsList[int]: An array of one or more group IDs.
permission_levelstr: Options are: “read”, “write”, or “manage”.
share_email_bodystr, optional: Custom body text for e-mail sent on a share.
send_shared_emailbool, optional: Send email to the recipients of a share.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

put_civis_data_match_shares_users(id: int, user_ids: List[int], permission_level: str, *, share_email_body: str = None, send_shared_email: bool = None) → Response

Set the permissions users have on this object

Parameters:

idint: The ID of the resource that is shared.
user_idsList[int]: An array of one or more user IDs.
permission_levelstr: Options are: “read”, “write”, or “manage”.
share_email_bodystr, optional: Custom body text for e-mail sent on a share.
send_shared_emailbool, optional: Send email to the recipients of a share.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

put_civis_data_match_transfer(id: int, user_id: int, include_dependencies: bool, *, email_body: str = None, send_email: bool = None) → Response

Transfer ownership of this object to another user

Parameters:

idint: The ID of the resource that is shared.
user_idint: ID of target user
include_dependenciesbool: Whether or not to give manage permissions on all dependencies
email_bodystr, optional: Custom body text for e-mail sent on transfer.
send_emailbool, optional: Send email to the target user of the transfer?

Returns:

civis.Response

dependenciesList[civis.Response]
Dependent objects for this object
- object_typestr
  Dependent object type
- fco_typestr
  Human readable dependent object type
- idint
  Dependent object ID
- namestr
  Dependent object name, or nil if the requesting user cannot read this object
- permission_levelstr
  Permission level of target user (not user’s groups) for dependent object. Null if no target user or not shareable (e.g. a database table).
- descriptionstr
  Additional information about the dependency, if relevant
- sharedbool
  Whether dependent object was successfully shared with target user

put_geocode(id: int, name: str, remote_host_id: int, credential_id: int, source_schema_and_table: str, *, schedule: dict = None, notifications: dict = None, multipart_key: List[str] = None, limiting_sql: str = None, target_schema: str = None, target_table: str = None, country: str = None, provider: str = None, output_address: bool = None, parent_id: int = None) → Response

Replace all attributes of this Geocode Enhancement

Parameters:

idint

The ID for the enhancement.

namestr

The name of the enhancement job.

remote_host_idint

The ID of the remote host.

credential_idint

The ID of the remote host credential.

source_schema_and_tablestr

The source database schema and table.

scheduledict, optional

scheduledbool
If the item is scheduled.
scheduled_daysList[int]
Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
scheduled_hoursList[int]
Hours of the day it is scheduled on.
scheduled_minutesList[int]
Minutes of the day it is scheduled on.
scheduled_runs_per_hourint
Deprecated in favor of scheduled minutes.
scheduled_days_of_monthList[int]
Days of the month it is scheduled on, mutually exclusive with scheduledDays.

notificationsdict, optional

urlsList[str]
URLs to receive a POST request at job completion
success_email_subjectstr
Custom subject line for success e-mail.
success_email_bodystr
Custom body text for success e-mail, written in Markdown.
success_email_addressesList[str]
Addresses to notify by e-mail when the job completes successfully.
success_email_from_namestr
Name from which success emails are sent; defaults to “Civis.”
success_email_reply_tostr
Address for replies to success emails; defaults to the author of the job.
failure_email_addressesList[str]
Addresses to notify by e-mail when the job fails.
stall_warning_minutesint
Stall warning emails will be sent after this amount of minutes.
success_onbool
If success email notifications are on. Defaults to user’s preferences.
failure_onbool
If failure email notifications are on. Defaults to user’s preferences.

multipart_keyList[str], optional

The source table primary key.

limiting_sqlstr, optional

The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).

target_schemastr, optional

The output table schema.

target_tablestr, optional

The output table name.

countrystr, optional

The country of the addresses to be geocoded; either ‘us’ or ‘ca’.

providerstr, optional

The geocoding provider; one of postgis and geocoder_ca.

output_addressbool, optional

Whether to output the parsed address. Only guaranteed for the ‘postgis’ provider.

parent_idint, optional

Parent ID that triggers this enhancement.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
remote_host_idint
The ID of the remote host.
credential_idint
The ID of the remote host credential.
source_schema_and_tablestr
The source database schema and table.
multipart_keyList[str]
The source table primary key.
limiting_sqlstr
The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).
target_schemastr
The output table schema.
target_tablestr
The output table name.
countrystr
The country of the addresses to be geocoded; either ‘us’ or ‘ca’.
providerstr
The geocoding provider; one of postgis and geocoder_ca.
output_addressbool
Whether to output the parsed address. Only guaranteed for the ‘postgis’ provider.
archivedstr
The archival status of the requested item(s).
parent_idint
Parent ID that triggers this enhancement.

put_geocode_archive(id: int, status: bool) → Response

Update the archive status of this object

Parameters:

idint: The ID of the object.
statusbool: The desired archived status of the object.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
remote_host_idint
The ID of the remote host.
credential_idint
The ID of the remote host credential.
source_schema_and_tablestr
The source database schema and table.
multipart_keyList[str]
The source table primary key.
limiting_sqlstr
The limiting SQL for the source table. “WHERE” should be omitted (e.g. state=’IL’).
target_schemastr
The output table schema.
target_tablestr
The output table name.
countrystr
The country of the addresses to be geocoded; either ‘us’ or ‘ca’.
providerstr
The geocoding provider; one of postgis and geocoder_ca.
output_addressbool
Whether to output the parsed address. Only guaranteed for the ‘postgis’ provider.
archivedstr
The archival status of the requested item(s).
parent_idint
Parent ID that triggers this enhancement.

put_geocode_projects(id: int, project_id: int) → Response

Add a Geocode Enhancement to a project

Parameters:

idint: The ID of the Geocode Enhancement.
project_idint: The ID of the project.

Returns:

None: Response code 204: success

put_geocode_shares_groups(id: int, group_ids: List[int], permission_level: str, *, share_email_body: str = None, send_shared_email: bool = None) → Response

Set the permissions groups has on this object

Parameters:

idint: The ID of the resource that is shared.
group_idsList[int]: An array of one or more group IDs.
permission_levelstr: Options are: “read”, “write”, or “manage”.
share_email_bodystr, optional: Custom body text for e-mail sent on a share.
send_shared_emailbool, optional: Send email to the recipients of a share.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

put_geocode_shares_users(id: int, user_ids: List[int], permission_level: str, *, share_email_body: str = None, send_shared_email: bool = None) → Response

Set the permissions users have on this object

Parameters:

idint: The ID of the resource that is shared.
user_idsList[int]: An array of one or more user IDs.
permission_levelstr: Options are: “read”, “write”, or “manage”.
share_email_bodystr, optional: Custom body text for e-mail sent on a share.
send_shared_emailbool, optional: Send email to the recipients of a share.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

put_geocode_transfer(id: int, user_id: int, include_dependencies: bool, *, email_body: str = None, send_email: bool = None) → Response

Transfer ownership of this object to another user

Parameters:

idint: The ID of the resource that is shared.
user_idint: ID of target user
include_dependenciesbool: Whether or not to give manage permissions on all dependencies
email_bodystr, optional: Custom body text for e-mail sent on transfer.
send_emailbool, optional: Send email to the target user of the transfer?

Returns:

civis.Response

dependenciesList[civis.Response]
Dependent objects for this object
- object_typestr
  Dependent object type
- fco_typestr
  Human readable dependent object type
- idint
  Dependent object ID
- namestr
  Dependent object name, or nil if the requesting user cannot read this object
- permission_levelstr
  Permission level of target user (not user’s groups) for dependent object. Null if no target user or not shareable (e.g. a database table).
- descriptionstr
  Additional information about the dependency, if relevant
- sharedbool
  Whether dependent object was successfully shared with target user

put_identity_resolution(id: int, name: str, sources: List[dict], *, schedule: dict = None, notifications: dict = None, threshold: float = None, match_target_id: int = None, enforced_links: List[dict] = None, customer_graph: dict = None, golden_table: dict = None, link_scores: dict = None) → Response

Replace all attributes of this Identity Resolution Enhancement

Parameters:

idint

The ID for the enhancement.

namestr

The name of the enhancement job.

sourcesList[dict]

The source(s) to resolve via a run of this job.

namestr
A user-specified name for the source.
descriptionstr
A description of the source.
database_namestr
The name of the source database.
schema_namestr
The name of the source schema.
table_namestr
The name of the source table.
field_mappingdict
A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix

scheduledict, optional

scheduledbool
If the item is scheduled.
scheduled_daysList[int]
Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
scheduled_hoursList[int]
Hours of the day it is scheduled on.
scheduled_minutesList[int]
Minutes of the day it is scheduled on.
scheduled_runs_per_hourint
Deprecated in favor of scheduled minutes.
scheduled_days_of_monthList[int]
Days of the month it is scheduled on, mutually exclusive with scheduledDays.

notificationsdict, optional

urlsList[str]
URLs to receive a POST request at job completion
success_email_subjectstr
Custom subject line for success e-mail.
success_email_bodystr
Custom body text for success e-mail, written in Markdown.
success_email_addressesList[str]
Addresses to notify by e-mail when the job completes successfully.
success_email_from_namestr
Name from which success emails are sent; defaults to “Civis.”
success_email_reply_tostr
Address for replies to success emails; defaults to the author of the job.
failure_email_addressesList[str]
Addresses to notify by e-mail when the job fails.
stall_warning_minutesint
Stall warning emails will be sent after this amount of minutes.
success_onbool
If success email notifications are on. Defaults to user’s preferences.
failure_onbool
If failure email notifications are on. Defaults to user’s preferences.

thresholdfloat (float), optional

A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.

match_target_idint, optional

The ID of the Civis Data (Custom) match target. See /match_targets for IDs.

enforced_linksList[dict], optional

A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.

source1str
Name of the first source. Must be defined in Sources list.
source1_join_colstr
Column from the first source to join on.
source2str
Name of the second source. Must be defined in Sources list
source2_join_colstr
Column from the second source to join on.

customer_graphdict, optional

database_namestr
The name of the destination database.
schema_namestr
The name of the destination schema.
table_namestr
The name of the destination table.

golden_tabledict, optional

database_namestr
The name of the destination database.
schema_namestr
The name of the destination schema.
table_namestr
The name of the destination table.
fieldsList[dict]
- field_namestr
  The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.
- rule_typestr
  One of [“automatic”, “preferred_source”]. Determines how the system will choose the value for a record. “automatic” will use the most frequent well-formatted value. “preferred_source” allows the user to prioritize values from particular sources over others.
- source_preferencesList[dict]
  Rank order for sources, when rule_type is “preferred_source”.
  
  source_namestr
  The name of the source.
  
  rankingint
  How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.

link_scoresdict, optional

database_namestr
The name of the destination database.
schema_namestr
The name of the destination schema.
table_namestr
The name of the destination table.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
archivedstr
The archival status of the requested item(s).
thresholdfloat (float)
A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.
sourcesList[civis.Response]
The source(s) to resolve via a run of this job.
- namestr
  A user-specified name for the source.
- descriptionstr
  A description of the source.
- database_namestr
  The name of the source database.
- schema_namestr
  The name of the source schema.
- table_namestr
  The name of the source table.
- field_mappingcivis.Response
  A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix
match_target_idint
The ID of the Civis Data (Custom) match target. See /match_targets for IDs.
enforced_linksList[civis.Response]
A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.
- source1str
  Name of the first source. Must be defined in Sources list.
- source1_join_colstr
  Column from the first source to join on.
- source2str
  Name of the second source. Must be defined in Sources list
- source2_join_colstr
  Column from the second source to join on.
customer_graphcivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
golden_tablecivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
- fieldsList[civis.Response]
  
  field_namestr
  The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.
  
  rule_typestr
  One of [“automatic”, “preferred_source”]. Determines how the system will choose the value for a record. “automatic” will use the most frequent well-formatted value. “preferred_source” allows the user to prioritize values from particular sources over others.
  
  source_preferencesList[civis.Response]
  Rank order for sources, when rule_type is “preferred_source”.
  
  source_namestr
  The name of the source.
  
  rankingint
  How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.
link_scorescivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
legacy_idint
ID of this pipeline in the legacy IDR service application.
last_runcivis.Response
- id : int
- state : str
- created_atstr (time)
  The time that the run was queued.
- started_atstr (time)
  The time that the run started.
- finished_atstr (time)
  The time that the run completed.
- errorstr
  The error message for this run, if present.
- configstr
  How the Identity Resolution job was configured for this run.
- sample_records_querystr
  A SQL query to produce a sample of records to inspect.
- expand_cluster_querystr
  A customizable query to view PII associated with resolved ids.
- run_metricscivis.Response
  
  num_recordsint
  The number of input records for this run.
  
  unique_idsint
  The number of distinct unique IDs in the input records for this run.
  
  unique_deduplicated_idsint
  The number of resolved IDs associated with more than one unique ID in the input.
  
  max_cluster_sizeint
  The number of records in the largest cluster of resolved IDs.
  
  avg_cluster_sizefloat (float)
  The average number of records with the same resolved ID.
  
  cluster_size_frequenciescivis.Response
  A mapping from numbers of records with the same resolved ID (i.e., sizes of clusters) to numbers of such clusters. For example, if there were 10 clusters with 2 records each, 2 would be a key in the mapping, and 10 would be its value.
- error_sectionstr
  If there was a failure, this will denote which section of the Identity Resolution job failed. One of: data_preparation, compute_setup or data_processing.

put_identity_resolution_archive(id: int, status: bool) → Response

Update the archive status of this object

Parameters:

idint: The ID of the object.
statusbool: The desired archived status of the object.

Returns:

civis.Response

idint
The ID for the enhancement.
namestr
The name of the enhancement job.
typestr
The type of the enhancement (e.g CASS-NCOA)
created_atstr (time)
The time this enhancement was created.
updated_atstr (time)
The time the enhancement was last updated.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
statestr
The status of the enhancement’s last run
schedulecivis.Response
- scheduledbool
  If the item is scheduled.
- scheduled_daysList[int]
  Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth
- scheduled_hoursList[int]
  Hours of the day it is scheduled on.
- scheduled_minutesList[int]
  Minutes of the day it is scheduled on.
- scheduled_runs_per_hourint
  Deprecated in favor of scheduled minutes.
- scheduled_days_of_monthList[int]
  Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notificationscivis.Response
- urlsList[str]
  URLs to receive a POST request at job completion
- success_email_subjectstr
  Custom subject line for success e-mail.
- success_email_bodystr
  Custom body text for success e-mail, written in Markdown.
- success_email_addressesList[str]
  Addresses to notify by e-mail when the job completes successfully.
- success_email_from_namestr
  Name from which success emails are sent; defaults to “Civis.”
- success_email_reply_tostr
  Address for replies to success emails; defaults to the author of the job.
- failure_email_addressesList[str]
  Addresses to notify by e-mail when the job fails.
- stall_warning_minutesint
  Stall warning emails will be sent after this amount of minutes.
- success_onbool
  If success email notifications are on. Defaults to user’s preferences.
- failure_onbool
  If failure email notifications are on. Defaults to user’s preferences.
running_ascivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
archivedstr
The archival status of the requested item(s).
thresholdfloat (float)
A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.
sourcesList[civis.Response]
The source(s) to resolve via a run of this job.
- namestr
  A user-specified name for the source.
- descriptionstr
  A description of the source.
- database_namestr
  The name of the source database.
- schema_namestr
  The name of the source schema.
- table_namestr
  The name of the source table.
- field_mappingcivis.Response
  A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix
match_target_idint
The ID of the Civis Data (Custom) match target. See /match_targets for IDs.
enforced_linksList[civis.Response]
A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.
- source1str
  Name of the first source. Must be defined in Sources list.
- source1_join_colstr
  Column from the first source to join on.
- source2str
  Name of the second source. Must be defined in Sources list
- source2_join_colstr
  Column from the second source to join on.
customer_graphcivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
golden_tablecivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
- fieldsList[civis.Response]
  
  field_namestr
  The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.
  
  rule_typestr
  One of [“automatic”, “preferred_source”]. Determines how the system will choose the value for a record. “automatic” will use the most frequent well-formatted value. “preferred_source” allows the user to prioritize values from particular sources over others.
  
  source_preferencesList[civis.Response]
  Rank order for sources, when rule_type is “preferred_source”.
  
  source_namestr
  The name of the source.
  
  rankingint
  How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.
link_scorescivis.Response
- database_namestr
  The name of the destination database.
- schema_namestr
  The name of the destination schema.
- table_namestr
  The name of the destination table.
legacy_idint
ID of this pipeline in the legacy IDR service application.
last_runcivis.Response
- id : int
- state : str
- created_atstr (time)
  The time that the run was queued.
- started_atstr (time)
  The time that the run started.
- finished_atstr (time)
  The time that the run completed.
- errorstr
  The error message for this run, if present.
- configstr
  How the Identity Resolution job was configured for this run.
- sample_records_querystr
  A SQL query to produce a sample of records to inspect.
- expand_cluster_querystr
  A customizable query to view PII associated with resolved ids.
- run_metricscivis.Response
  
  num_recordsint
  The number of input records for this run.
  
  unique_idsint
  The number of distinct unique IDs in the input records for this run.
  
  unique_deduplicated_idsint
  The number of resolved IDs associated with more than one unique ID in the input.
  
  max_cluster_sizeint
  The number of records in the largest cluster of resolved IDs.
  
  avg_cluster_sizefloat (float)
  The average number of records with the same resolved ID.
  
  cluster_size_frequenciescivis.Response
  A mapping from numbers of records with the same resolved ID (i.e., sizes of clusters) to numbers of such clusters. For example, if there were 10 clusters with 2 records each, 2 would be a key in the mapping, and 10 would be its value.
- error_sectionstr
  If there was a failure, this will denote which section of the Identity Resolution job failed. One of: data_preparation, compute_setup or data_processing.

put_identity_resolution_projects(id: int, project_id: int) → Response

Add an Identity Resolution Enhancement to a project

Parameters:

idint: The ID of the Identity Resolution Enhancement.
project_idint: The ID of the project.

Returns:

None: Response code 204: success

put_identity_resolution_shares_groups(id: int, group_ids: List[int], permission_level: str, *, share_email_body: str = None, send_shared_email: bool = None) → Response

Set the permissions groups has on this object

Parameters:

idint: The ID of the resource that is shared.
group_idsList[int]: An array of one or more group IDs.
permission_levelstr: Options are: “read”, “write”, or “manage”.
share_email_bodystr, optional: Custom body text for e-mail sent on a share.
send_shared_emailbool, optional: Send email to the recipients of a share.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

put_identity_resolution_shares_users(id: int, user_ids: List[int], permission_level: str, *, share_email_body: str = None, send_shared_email: bool = None) → Response

Set the permissions users have on this object

Parameters:

idint: The ID of the resource that is shared.
user_idsList[int]: An array of one or more user IDs.
permission_levelstr: Options are: “read”, “write”, or “manage”.
share_email_bodystr, optional: Custom body text for e-mail sent on a share.
send_shared_emailbool, optional: Send email to the recipients of a share.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

put_identity_resolution_transfer(id: int, user_id: int, include_dependencies: bool, *, email_body: str = None, send_email: bool = None) → Response

Transfer ownership of this object to another user

Parameters:

idint: The ID of the resource that is shared.
user_idint: ID of target user
include_dependenciesbool: Whether or not to give manage permissions on all dependencies
email_bodystr, optional: Custom body text for e-mail sent on transfer.
send_emailbool, optional: Send email to the target user of the transfer?

Returns:

civis.Response

dependenciesList[civis.Response]
Dependent objects for this object
- object_typestr
  Dependent object type
- fco_typestr
  Human readable dependent object type
- idint
  Dependent object ID
- namestr
  Dependent object name, or nil if the requesting user cannot read this object
- permission_levelstr
  Permission level of target user (not user’s groups) for dependent object. Null if no target user or not shareable (e.g. a database table).
- descriptionstr
  Additional information about the dependency, if relevant
- sharedbool
  Whether dependent object was successfully shared with target user