​
facets

Array of string, Optional Faceting gives you an idea of what attributes are available within your search. This can help end users select from various facets and filter listings, providing a great front-end experience for the end users. Buildify currently supports plenty of attributes for facets such as:
  • type
  • agents
  • owners
  • country
  • builders
  • amenities
  • architects
  • brokerages
  • communities
  • salesCentres
  • neighbourhood
  • cityOrDistrict
  • municipalities
  • salesCompanies
  • marketingCompanies
A simple run to getFacetCounts with facets=["*"] will provide all the available facets with their counts.
Facets

{
  "type": {
    "Condo": 155,
    "Townhouse": 47,
    "Single Family Home": 7
  },
  "agents": {
    "Agents/44ID0o7hITDFQpPLB56b": 1
  },
  "owners": {
    "Owners/RhlTKtN8hAxQeSBWV8u0": 3
  },
  "country": {
    "Canada": 186
  },
  "builders": {
    "Builders/qlUGOOwez5tUFZ1TYi3o": 6,
    "Builders/MiltzUNTqLZLDqO4j35k": 5,
    "Builders/NYv468NPic57dwCRDz8a": 5,
    "Builders/P1VyhUGpSyRvopl8JJU0": 5,
    "Builders/hHE9I4XPOBYn2jLlWfDQ": 5,
    "Builders/BEjGHxTQ7jVCDnJ0RFLf": 4
  },
  "amenities": {
    "Party Room": 29,
    "Fitness Centre": 24,
    "Yoga Studio": 20,
    "BBQ Area": 12,
    "24-hour concierge": 10,
    "Outdoor Terrace": 10
  },
  "architects": {
    "Architects/7VCS1oL7q40LlVyCifz9": 15,
    "Architects/A2Dc3i7RRoDpspPJelrp": 8,
    "Architects/OqfG13GI0voKdfteWXKC": 8,
    "Architects/KDxeUMlzUncEjKerNf9t": 6,
    "Architects/iS5n0h3EjZI8VLzfIuQ4": 5,
    "Architects/qTVx6Xd9PBd9S6XUPxf1": 5
  },
  "brokerages": {
    "Brokerages/z4KyROBDpXyacBnavR9k": 1
  },
  "communities": {
    "Communities/i58PTsKEKwtfMNgZjJza": 2,
    "Communities/8iddPeDtCHo2hUTavJ58": 1,
    "Communities/CBL6rOog3JGDEDFSuj2M": 1
  },
  "salesCentres": {
    "SalesCentres/NwpgmXlMHnqiaJ2ii9xW": 2
  },
  "neighbourhood": {
    "Sherwood Park": 9,
    "The Queensway": 8,
  },
  "cityOrDistrict": {
    "Toronto": 186
  },
  "municipalities": {
    "C08": 22,
    "C01": 21,
    "C02": 11,
    "W02": 10,
    "W08": 10,
    "C10": 9
  },
  "salesCompanies": {
    "SalesCompanies/oS8cOQZcsBs4BWwFkfqn": 13,
    "SalesCompanies/IAItdUQirIrFZ2hMfSSn": 11,
    "SalesCompanies/ba4RvxWbeYXwDcgQJ0hO": 8
  },
  "interiorDesigners": {
    "InteriorDesigners/9715t6uxsL5q5g9jDIqH": 9,
    "InteriorDesigners/H3H5ptxRrlK5EbeIYjSK": 9,
    "InteriorDesigners/NvtlJSzvmJJoT0BbSIRU": 4,
  },
  "marketingCompanies": {
    "Marketers/NxSBZCfHPjEod190tsyO": 11,
    "Marketers/OqDBR2Iqy29cMJ3Pi0Bp": 9,
    "Marketers/fsHEps24lbs9kO1UxZ7w": 5,
    "Marketers/5DQb8M8Mm4RAqiGqfljA": 4,
    "Marketers/QG9xGbsooqc5p2qgTihv": 3,
    "Marketers/QOWed7CGYBVyYgOaCVxD": 3,
    "Marketers/thLBYkCgOx0QIWxviAC4": 3
  }
}

​

Note: The actual response may be different. For illustration purposes, the response has been limited.
Within your search query, you can use facets=["amenities"] to retrieve counts of each of the amenities available within your search. Facets are returned in the response with the facets key, where each object represents a facet.
Returned facet counts represent the whole search result,s not just the paginated one (results that are there but not returned due to pagination).

​
Example


{
     "search": "Residences",
     "page": 0,
     "perPage": 1,
     "facets": [
          "amenities"
     ]
}