Variable

Base definition

{
"kind": "variable",
"uri": string,
"url": string,
"name": string,
"type": string("boolean","integer","float","string","date","dateTime"),
"index": integer,
"label": string,
}

Get definition

In addition to the base definition, any variable resource returned by a get request will contain the following properties:

{
"description": string,
"valueLabels": [
{ "value": string, "label": string }
],
"statistics": {
"status": string("queued","running","completed","failed"),
"count": string(int64),
"numDistinct": string(int64),
"min": number|string(int64),
"max": number|string(int64),
"mean": number|string(int64),
"approxMedian": number|string(int64)
}
}

Documentation

Fields

Base

kind

string

The resource type. Will always be "variable".

uri

string

The fully qualified reference to this upload, for use in generating calls to this API.

For example, /tables/imathews.example:123.test:456/variables/var1

url

string

The variable's discoverable url through a web browser interface.

name

string

The variable's name. Will always be unique to the variable's table.

type

string

The variable's type. Will be one of:

"boolean","integer","float","string","date","dateTime"

index

integer

A zero based counter for the variable's ordinality for its table.

label

string

A user-provided label for the variable. May be null.

Get

description

string

A user-provided description for the variable, typically longer than the label. May be null.

valueLabels

array<object>

An array of value labels. Value labels are used to provide mappings between the data content of a cell and human-readable meaning of that content.

valueLabels.value

string

The value associated with a given valueLabel

valueLabels.label

string

The human-readable label for the associated value.

statistic

object

An object containing univariate summary statistics about the variable.

If the statistics have not yet been computed on the variable, statistic.status will running and many (or all) of the statistic fields will be missing until status is completed.

statistic.status

string

The current status of the statistic's computation. Will be one of completed, running, or failed. If the statistic is failed, it can only be recomputed in the UI.

statistic.count

string(int64)

The number of non-null values for this variable.

statistic.numDistinct

string(int64)

The number of distinct values for this variable.

statistic.min

number|string(int64)

The minimum value of this variable. Will be null for variables of string and boolean type. For integers, will be a string(int64). For all other variable types this will be a number.

If the variable is of type date or dateTime, this number represents the number of milliseconds since the epoch (1970-01-01). If the variable is of type time, this number represents the number of milliseconds since 00:00:00.

statistic.max

number|string(int64)

The maximum value of this variable. See statistic.min for information about different variable types.

statistic.mean

number|string(int64)

The average value of this variable. See statistic.min for information about different variable types.

statistic.approxMedian

number|string(int64)

The approximate median of this variable. Uses the BigQuery APPROX_QUANTILES function.

See statistic.min for information about different variable types.

statistic.stdDev

number

The sample (unbiased) standard deviation of this variable. Will be null for variables of string and boolean type. For all other variable types this will be a number.

If the variable is of type date , time, or dateTime, this number measures the standard deviation in milliseconds.