Comment on page
Variable
{
"kind": "variable",
"uri": string,
"url": string,
"name": string,
"type": string("boolean","integer","float","string","date","dateTime","geography"),
"isFileId": bool,
"index": integer,
"label": string,
}
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": integer,
"numDistinct": integer,
"min": number,
"max": number,
"mean": number,
"approxMedian": number,
"geoBBox": {
"westLongitude": number,
"eastLongitude": number,
"northLatitude": number,
"southLatitude": number
}
}
}
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" |
isFileId | boolean
Whether the variable contains file_ids, which can be used to uniquely reference and download a File. |
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. |
statistics | 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 . |
statistics.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. |
statistics.count | integer The number of non-null values for this variable. |
statistics.numDistinct | integer The number of distinct values for this variable. |
statistics.min | number The minimum value of this variable.
Will be null for variables of string and boolean type. 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 . |
statistics.max | number The maximum value of this variable.
See statistic.min for information about different variable types. |
statistics.mean | number The average value of this variable.
See statistic.min for information about different variable types. |
statistics.approxMedian | number See statistic.min for information about different variable types. |
statistics.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. |
statistics.geoBBox | object
An object describing the geographic bounding box of the variable. Will only be present for variables of "geography" type. |
statistics.geoBBox
.westLongitude
.eastLongitude
.northLatitude
.southLatitude | number
Each property represents one side of the bounding box, expressed in numeric degrees. |
Last modified 1yr ago