enhancements_get_geocode_runs {civis}R Documentation

Check status of a run

Description

Check status of a run

Usage

enhancements_get_geocode_runs(id, run_id)

Arguments

id

integer required. The ID of the geocode.

run_id

integer required. The ID of the run.

Value

A list containing the following elements:

id

integer, The ID of the run.

geocodeId

integer, The ID of the geocode.

state

string, The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.

isCancelRequested

boolean, True if run cancel requested, else false.

startedAt

string, The time the last run started at.

finishedAt

string, The time the last run completed.

error

string, The error, if any, returned by the run.


[Package civis version 3.0.0 Index]