VariableStatistics

Get definition

{
	"kind": "variableStatistics",
	"uri": string,
	"url": string,
	"variable": {
	  "kind": variable,
	  "name": str,
	  "type": str (enum variable_type)
	},
	"status": string("queued","running","completed","failed"),
	"count": integer,
	"numDistinct": integer,
	"min": number,
	"max": number,
	"mean": number,
	"approxMedian": number,
	"frequencyDistribution": null | [
	  { 
	    value: number | string | boolean, 
	    count: number,
	    label: string | null
	  }
	],
	"geoCentroid": {
	  "longitude": number,
	  "latitude" number
	},
	"geoBBox": {
	  "westLongitude": number,
	  "eastLongitude": number,
	  "northLatitude": number,
	  "southLatitude": number
	}
}

Documentation

Fields

Get

kind

string

The resource type. Will always be "variable".

uri

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

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

url

string The variable's discoverable url through a web browser interface, which also displays the variable's statistics.

variable

status

string

The current status of the statistic's computation. Will be one of completed, running, queued, or failed. If the statistic is failed, it can only be recomputed in the UI. Other statistic fields will only be populated once status == "completed"

count

integer

The number of non-null values for this variable.

numDistinct

integer

The number of distinct values for this variable.

min

number

The minimum value of this variable. Will be null for variables of 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. If the variable is of type string, will be the minimum string length. If the variable is of type geography, will be the minimum number of vertices encountered.

max

number

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

mean

number

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

approxMedian

number

See statistic.min for information about different variable types.

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.

frequencyDistribution[]

object The frequencyDistribution, if present, is an array of values observed and their respective counts. Note that frequency distribution may not always be present (e.g., for variables with high heterogeneity of values), and is limited to the 10,000 most common values – meaning that it may only represent a subset of values on the variable.

frequencyDistribution.value

number | string | boolean The observed value. Type will correspond to the variable type.

frequencyDistribution.count

number The count of observations that match this value

frequencyDistribution.label

string Included if the variable has specified valueLabels in its metadata, and there is a corresponding label for this value.

geoCentroid

object An object containing longitude and latitude properties, representing the weighted centroid of all geometries.

geoBBox

object An object describing the geographic bounding box of the variable. Will only be present for variables of "geography" type.

geoBBox .westLongitude .eastLongitude .northLatitude .southLatitude

number Each property represents one side of the bounding box, expressed in numeric degrees.

Last updated

Was this helpful?