List — exports_list • civis

List

exports_list(
  type = NULL,
  author = NULL,
  status = NULL,
  hidden = NULL,
  archived = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

type	string optional. If specified, return exports of these types. It accepts a comma-separated list, possible values are 'database' and 'gdoc'.
author	string optional. If specified, return exports from this author. It accepts a comma-separated list of author ids.
status	string optional. If specified, returns export with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.
hidden	boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.
archived	string optional. The archival status of the requested item(s).
limit	integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.
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 updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at.
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:

integer, The ID for this export.

name

string, The name of this export.

type

string, The type of export.

createdAt

string, The creation time for this export.

updatedAt

string, The last modification time for this export.

state

string,

lastRun

list, A list containing the following elements:

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.

author

list, A list containing the following elements:

id integer, The ID of this user.
name string, This user's name.
username string, This user's username.
initials string, This user's initials.
online boolean, Whether this user is online.