predictions_get {civis}

Show the specified prediction

Description

Show the specified prediction

Usage

predictions_get(id)

Arguments

id

integer required. The ID of the prediction.

Value

A list containing the following elements:

id

integer, The ID of the prediction.

modelId

integer, The ID of the model used for this prediction.

scoredTableId

integer, The ID of the source table for this prediction.

scoredTableName

string, The name of the source table for this prediction.

outputTableName

string, The name of the output table for this prediction.

state

string, The state of the last run of this prediction.

error

string, The error, if any, of the last run of this prediction.

startedAt

string, The start time of the last run of this prediction.

finishedAt

string, The end time of the last run of this prediction.

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.

scoredTables

array, An array containing the following fields:

• id integer, The ID of the table with created predictions.

• schema string, The schema of table with created predictions.

• name string, The name of table with created predictions.

• createdAt string, The time when the table with created predictions was created.

• scoreStats array, An array of metrics on the created predictions.

schedule

list, A list containing the following elements:

• scheduled boolean, If the item is scheduled.

• scheduledDays array, Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth

• scheduledHours array, Hours of the day it is scheduled on.

• scheduledMinutes array, Minutes of the day it is scheduled on.

• scheduledRunsPerHour integer, Deprecated in favor of scheduled minutes.

• scheduledDaysOfMonth array, Days of the month it is scheduled on, mutually exclusive with scheduledDays.

limitingSQL

string, A SQL WHERE clause used to scope the rows to be predicted.

primaryKey

array, The primary key or composite keys of the table being predicted.