Filter reference

Filters that determine the valid API query parameters and access patterns to your data.

A single request can have multiple various (or same) types of filters specified. Filters are implemented via query parameters and hence, query parameter syntax applies. For example:

$ curl https://example.api.tapintodata.com/example?key1=value1&key2=value2

Text equal

Filters for an exact value. This is the default. Only returns exact matches for key and value.

Loose text equal

Filters for an approximate value. The filter value will be matched against column values, ignoring the following in both:

• Whitespace from both ends of the value.
• Multiple consecutive whitespaces within the value.
• Casing.
• Punctuation.

H3

Geospatial filtering based on H3 indexing.

To configure:

• Specify a Name, which will be the query key.
• In Target, select whether coordinates are stored within a "Single coordinates column" in the shape of an array [Longitude, Latitude] or "Separate latitude and longitude columns".
• Specify the column(s) in which the coordinates are stored.

The filter value can be any of:

• Within an H3 cell index (e.g. 871972765ffffff).
• Within a radius (in kilometres) of a central point (e.g. { lat: 55, lng: -3, radius: 1 }). Note that this is approximate may include results from outside the radius.
• Within a GeoJSON bounding box array (e.g. [south lng, west lat, north lng, east lat]). Note that this is approximate may include results from outside the bounds.

Note: If you only have postcode data, many nations will have open licensed postcode lookup files that map postcodes to coordinates, which you can use to join with your dataset in models. For example, you can find the one for the United Kingdom here.