civis (version 2.1.0)

tables_get_enhancements_table_matchings: View a table matching enhancement

Description

View a table matching enhancement

Usage

tables_get_enhancements_table_matchings(id, source_table_id)

Arguments

id

integer required. The ID of the enhancement.

source_table_id

integer required. The ID of the table that was enhanced.

Value

A list containing the following elements:

id

integer, The ID of the enhancement.

sourceTableId

integer, The ID of the table that was enhanced.

state

string, The state of the enhancement, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.

enhancedTableSchema

string, The schema name of the table created by the enhancement.

enhancedTableName

string, The name of the table created by the enhancement.

threshold

number, The confidence threshold which must be met for two individuals to be declared a match. Must be less than or equal to 1 and greater than or equal to 0.

maxMatches

integer, The maximum number of individuals a person may be matched with.A value of 0 indicates that all matches should be returned.

matchTableId

integer, The ID of the Redshift table to match against.