Skip to main content
URL: http://<db.host>:<db.port>/filter
Filters data based on the specified expression. The results are stored in a result set with the given input parameter view_name. For details see Expressions. The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Input Parameter Description

table_name
string
Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
view_name
string
If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view.The default value is ”.
expression
string
The select expression to filter the specified table. For details see Expressions.
options
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:
status
String
‘OK’ or ‘ERROR’
message
String
Empty if success or an error message
data_type
String
‘filter_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 /filter endpoint:Empty string in case of an error.