Match Filter Guide
This article describes how to use the match
comparison type
when filtering your results from Cvent's REST API to get accurate search results
The match filter lets you filter results returned by REST API requests to get the right data faster. The match filter is available on endpoints such as List Sessions, List Attendees, List Speakers.
Relevance Score#
When providing search terms to the match filter, searchable objects in your account are returned with a relevance score greater than 0. This measures the likelihood that a particular Cvent object is what you’re searching for. A higher score indicates the object is more relevant. The main factors impacting the relevancy score are:
- Term frequency. The more times the term appears in the object, the more relevant it is.
- Inverse frequency. The more objects in your account that contain the searched term, the less important the term becomes.
- Field length. Data in short fields are more likely to be relevant than data in long fields (applicable if multiple fields are supported). For example, a session name is more relevant than a session’s name that appears in the 3,000-word description of the session.
Higher scores indicate more relevant results.
Use#
To leverage the match filter, it should be passed as a query parameter when making a request to a particular API. For example, a List Sessions request where we search for keynote addresses might look like this:
The response will contain all results with a relevance score greater than 0.
Limitations#
- The match filter is not supported on all endpoints. Check the documentation on the desired endpoint to confirm.
- Generally, a minimum of 3 characters is recommended for the match search term.