enhancements_list_civis_data_match_runs: List runs for the given Civis Data Match job

In civis: R Client for the 'Civis Platform API'

List runs for the given Civis Data Match job

Description

List runs for the given Civis Data Match job

Usage

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

Arguments

id	integer required. The ID of the Civis Data Match 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.

Value

An array containing the following fields:

id	integer, The ID of the run.
civisDataMatchId	integer, The ID of the Civis Data Match 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.

civis documentation built on Aug. 30, 2025, 1:08 a.m.