Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/aggregate/histogram

URL: http://<db.host>:<db.port>/aggregate/histogram

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

Name

Type

Description

table_name

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.

column_name

string

Name of a column or an expression of one or more column names over which the histogram will be calculated.

start

double

Lower end value of the histogram interval, inclusive.

end

double

Upper end value of the histogram interval, inclusive.

interval

double

The size of each bin within the start and end parameters.

options

map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)	Parameter Description
value_column	The name of the column to use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float).

Output Parameter Description

The GPUdb 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:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'aggregate_histogram_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

This embedded JSON represents the result of the /aggregate/histogram endpoint:

Name	Type	Description
counts	array of doubles	The array of calculated values that represents the histogram data points.
start	double	Value of input parameter start.
end	double	Value of input parameter end.
info	map of string to strings	Additional information.

Empty string in case of an error.