Learn R Programming
civis (version 3.1.3)

enhancements_list_identity_resolution: List Identity Resolution Enhancements

Description

List Identity Resolution Enhancements

Usage

enhancements_list_identity_resolution(
  archived = NULL,
  status = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Value

An array containing the following fields:

id

integer, The ID for the enhancement.

name

string, The name of the enhancement job.

type

string, The type of the enhancement (e.g CASS-NCOA)

createdAt

string, The time this enhancement was created.

updatedAt

string, The time the enhancement was last updated.

author

list, A list containing the following elements:

  • id integer, The ID of this user.

  • name string, This user's name.

  • username string, This user's username.

  • initials string, This user's initials.

  • online boolean, Whether this user is online.

state

string, The status of the enhancement's last run

archived

string, The archival status of the requested item(s).

sources

array, An array containing the following fields:

  • name string, A user-specified name for the source.

lastRun

list, A list containing the following elements:

  • id integer,

  • state string,

  • createdAt string, The time that the run was queued.

  • startedAt string, The time that the run started.

  • finishedAt string, The time that the run completed.

  • error string, The error message for this run, if present.

  • sampleRecordsQuery string, A SQL query to produce a sample of records to inspect.

  • expandClusterQuery string, A customizable query to view PII associated with resolved ids.

  • runMetrics list . A list containing the following elements:

    • numRecords integer, The number of input records for this run.

    • uniqueIds integer, The number of distinct unique IDs in the input records for this run.

    • uniqueDeduplicatedIds integer, The number of resolved IDs associated with more than one unique ID in the input.

    • maxClusterSize integer, The number of records in the largest cluster of resolved IDs.

    • avgClusterSize number, The average number of records with the same resolved ID.

    • clusterSizeFrequencies object, 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.

Arguments

archived

string optional. The archival status of the requested item(s).

status

string optional. If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.

limit

integer optional. Number of results to return. Defaults to 50. Maximum allowed is 100.

page_num

integer optional. Page number of the results to return. Defaults to the first page, 1.

order

string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, last_run_updated_at.

order_dir

string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.