Guide to viewing API parameters on Search Results page

Unknown
Unknown
edited November 2021 in Support Agents

This is intended as a simple guide on how you can access the specific API parameters being used on the Search Results page. When the New Search Page is enabled (on the Vanilla Labs page), you can see these details in the developer tools.

To do this:

  1. Open dev tools,
  2. Go to the Network tab
  3. Make sure you have "All" selected.
  4. Load a Search Result page
  5. Select a "search?" call that is appropriate for what you're looking for.
  6. At this point, you can either copy the exact API call itself or see the parameters on the right-hand side.
Screen Shot 2021-11-05 at 10.37.44 AM.png

By looking at this data you can see exactly how the search results are ordered and what is included on the various filter pages.

Finally, if you're struggling to make an API call whose results line up with those on the search page, try setting the locale and adding a recordType to use events but not groups.

Events are not currently specified on the swagger /search endpoint, but the Search Results page does use them. I've found that changing these two things (locale and events) has affected the sort order even in situations where it didn't seem relevant to the results.

Categories