facet counts by places
This block is part of the places group and was last modified in core v15.0.0.
facet counts by places v15.0.0 Counts how many items in a list are near each category : “412 objects near a hospital” in one node. Counts items, not places: an item with three hospitals nearby counts once, which is what a facet over an inventory means. Pass categories with a shared radius, or filters for a named filter per facet.
- items required
v15.0.0arrayThe list to process. Either an array of geo points, or an array of objects with
point pathnaming where the coordinate sits. - point path
v15.0.0valueDotted path to the geo point inside each item, e.g.
general.location. Leave empty when the items are geo points themselves. - categories
v15.0.0arrayCategory groups to count, each using
radius. Either this orfiltersis required. - radius (m)
v15.0.0numberRadius applied to every category. Empty uses 500.
- filters
v15.0.0objectNamed filters, as
{facet name: filter}, for facets that need different radii or negation. Combined withcategoriesif both are given.
- counts
v15.0.0objectItem count per category group or named filter.
- total
v15.0.0numberItems that had a usable coordinate and were evaluated. Compare against the input length to spot missing coordinates.
- success
v15.0.0conditionTrue when the query ran. An empty result is still a success.
- error
v15.0.0valueError code when the query could not run:
PLACES_NOT_AVAILABLE,CATEGORIES_REQUIRED.
Core Releases
v15.0.0 This block was introduced inv15.0.0, click here to see the release notes. Back to
places Return to the main group to view all sub-groups Back to Places Return to the group to view all blocks within this group