Facet Terms

Facet Parameters (Category c.)

Facets return aggregate counts for possible filters. Example:

c.sex=on

A facet response includes:

  • displayName — User-visible label
  • displayCount — Result count string
  • params — Query string for applying this facet in next query
  • count - Result count
  • facets — Nested facet values (optional)

Common facets - Not all are available depending on the Search:

  • c.sex, c.collectionId, c.treeId
  • c.birthPlaceLevel0-2, c.deathPlaceLevel0-2, c.marragePlaceLevel0-2
  • c.birthYear0-1, c.deathYear0-1, c.marriageYear0-1

Example of Header Warning when facet not available:

Warning: 400 FamilySearch "Failure in upstream call: Search for [search name]. (upstream 400)", 400 FamilySearch "{"message":"Validation failed.","errors":["Specified count=[parameter] is not an allowed count term"]}"

Global Terms

  • m.defaultFacets=on
    Enable the default facets for the search system.
  • m.queryRequireDefault=on
    Turns on 'require' on all fields.