rcol (version 0.2.0)

cp_importer: Importer metrics

Description

Importer metrics

Usage

cp_importer(
  dataset_key = NULL,
  state = NULL,
  running = FALSE,
  start = 0,
  limit = 10,
  ...
)

Arguments

dataset_key

(character) a dataset key to filter by. optional

state

(character) filter listed import metrics by their state, e.g. the last failed import. one of: downloading, processing, inserting, unchanged, finished, canceled, failed. optional

running

(logical) if only a list of running imports should be returned. default: FALSE. optional

start

(integer) requested number of offset records. Default: 0

limit

(integer) requested number of maximum records to be returned. Default: 10; max: 1000

...

curl options passed on to verb-GET

Value

a named list, with slots offset (integer), limit (integer), total (integer), result (list), empty (boolean), and last (boolean). The result slot is a list itself, with any number of results as named lists

Examples

# NOT RUN {
if (cp_up("/importer?limit=1")) {
cp_importer(limit = 1)
}
# }