Skip to main content
URL: http://<db.host>:<db.port>/filter/byradius
Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a input parameter view_name is passed in as part of the request. For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.

​
Input Parameter Description

​
table_name
string
Name of the table on which the filter by radius operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
​
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 ”.
​
x_column_name
string
Name of the column to be used for the x-coordinate (the longitude) of the center.
​
x_center
double
Value of the longitude of the center. Must be within [-180.0, 180.0].The minimum allowed value is -180. The maximum allowed value is 180.
​
y_column_name
string
Name of the column to be used for the y-coordinate-the latitude-of the center.
​
y_center
double
Value of the latitude of the center. Must be within [-90.0, 90.0].The minimum allowed value is -90. The maximum allowed value is 90.
​
radius
double
The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of ‘42000’ means 42 km.The minimum allowed value is 0. The maximum allowed value is MAX_INT.
​
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_by_radius_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/byradius endpoint:Empty string in case of an error.