Filter Terms

Filter Parameters (Category f.)

Filters require an exact match. Place filters may include a level suffix (0, 1, 2) to distinguish hierarchy:

• f.birthLikePlace0 = country
• f.birthLikePlace1 = state
• f.birthLikePlace2 = city

Format: f.birthLikePlace1=3,Alberta (where 3 is the parent place ID and can be found when next level faceting is turned on).

Discovering Filter Values with Facets

The recommended way to find valid filter values is to use facets first:

Step 1: Turn on a facet to discover patterns

GET /platform/tree/search?q.givenName=John&q.surname=Smith&c.birthYear0=on

Step 2: Review the facets response

{
    "facets": [
      {
        "displayName": "Birth Year (Range)",
      	"displayCount": "7,754,618",
      	"params": "c.birthLikeDate0=on",
      	"count": 7754618,
      	"facets": [
          {
            "displayName": "0100",
            "displayCount": "480",
            "params": "c.birthLikeDate1=on&f.birthLikeDate0=100",
            "count": 480,
            "facets": []
          },
          {
            "displayName": "0200",
            "displayCount": "23",
            "params": "c.birthLikeDate1=on&f.birthLikeDate0=200",
            "count": 23,
            "facets": []
          },
					(etc)
        ]
      }
    ]
  }

Step 3: Copy the params field value

The params field tells you exactly what filter parameters to use: c.birthLikeDate1=on&f.birthLikeDate0=100

Step 4: Apply the filter GET /platform/tree/search?q.givenName=John&q.surname=Smith&c.birthLikeDate1=on&f.birthLikeDate0=100

This workflow ensures you're using valid filter values that match your actual data distribution.

See the Facet Terms Guide for more details on using facets for discovery.

Other popular filters:

• f.sex
• f.eventPlaceLevel0-5, f.birthYear0-1, f.deathYear0-1, etc.
• f.treeId, f.collectionId

Filters with empty values will match entries where the field is missing.

Filtering by Tree and Collection

You can filter results to specific trees using f.treeId or f.collectionId:

• f.treeId filters to a specific tree, such as a user tree, using its unique identifier.
• f.collectionId limits results to a defined collection type.