scripts_get_custom_runs: Check status of a run

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

Check status of a run

Description

Check status of a run

Usage

scripts_get_custom_runs(id, run_id)

Arguments

id	integer required. The ID of the Custom job.
run_id	integer required. The ID of the run.

Value

A list containing the following elements:

id	integer, The ID of the run.
customId	integer, The ID of the Custom 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.
maxMemoryUsage	number, If the run has finished, the maximum amount of memory used during the run, in MB. Only available if the backing script is a Python, R, or container script.
maxCpuUsage	number, If the run has finished, the maximum amount of cpu used during the run, in millicores. Only available if the backing script is a Python, R, or container script.

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