civis (version 3.1.2)

scripts_get_sql_runs: Check status of a run

Description

Check status of a run

Usage

scripts_get_sql_runs(id, run_id)

Value

A list containing the following elements:

id

integer, The ID of the run.

sqlId

integer, The ID of the sql.

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.

output

array, An array containing the following fields:

• outputName string, The name of the output file.

• fileId integer, The unique ID of the output file.

• path string, The temporary link to download this output file, valid for 36 hours.

outputCachedOn

string, The time that the output was originally exported, if a cache entry was used by the run.

Arguments

id

integer required. The ID of the sql.

run_id

integer required. The ID of the run.