Skip to main content
Performs a histogram calculation given a table, a column, and an interval function. The input parameter interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive—except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000. NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column.

​
Input Parameter Description

​
string
Name of the table on which the operation will be performed. Must be an existing table, in [schema_name.]table_name format, using standard name resolution rules.
​
string
Name of a column or an expression of one or more column names over which the histogram will be calculated.
​
double
Lower end value of the histogram interval, inclusive.
​
double
Upper end value of the histogram interval, inclusive.
​
double
The size of each bin within the start and end parameters.
​
map of string to strings
Optional parameters.The default value is an empty map ( {} ).

​
Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
​
String
‘OK’ or ‘ERROR’
​
String
Empty if success or an error message
​
String
‘aggregate_histogram_response’ or ‘none’ in case of an error
​
String
Empty string
​
JSON or String
This embedded JSON represents the result of the /aggregate/histogram endpoint:Empty string in case of an error.