enhancements_list_identity_resolution_runs: List runs for the given Identity Resolution job

Description

List runs for the given Identity Resolution job

enhancements_list_identity_resolution_runs(
  id,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

An array containing the following fields:

id

integer, The ID of the run.

identityResolutionId

integer, The ID of the Identity Resolution job.

state

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

isCancelRequested

boolean, True if run cancel requested, else false.

createdAt

string, The time the run was created.

startedAt

string, The time the run started at.

finishedAt

string, The time the run completed.

error

string, The error, if any, returned by the run.

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.

id: integer required. The ID of the Identity Resolution job.
limit: integer optional. Number of results to return. Defaults to 20. Maximum allowed is 100.
page_num: integer optional. Page number of the results to return. Defaults to the first page, 1.
order: string optional. The field on which to order the result set. Defaults to id. Must be one of: id.
order_dir: string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.