exports_list_files_csv_runs: List runs for the given csv_export

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

List runs for the given csv_export

Description

List runs for the given csv_export

Usage

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

Arguments

id	integer required. The ID of the csv_export.
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,
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.

civis documentation built on April 1, 2023, 12:01 a.m.