civis (version 3.1.3)

enhancements_get_identity_resolution_runs: Check status of a run

Description

Check status of a run

Usage

enhancements_get_identity_resolution_runs(id, run_id)

Value

A list containing the following elements:

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.

config

string, How the Identity Resolution job was configured for this 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.

errorSection

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

Arguments

id

integer required. The ID of the Identity Resolution job.

run_id

integer required. The ID of the run.