How to use OmniSearch
Taking advantage of the Omnisearch
The top search bar you see on the UI of OpenReplay is much more than a simple search bar, it allows you to craft very complex search queries with very little effort.
For the purpose of the examples shown here, we're going to be discussing the test application called "I'm bored", which suggests activities for you and your group of friends based on different search parameters.
Here is a screenshot of the UI our fake users would have the interact with:
Performing a simple search
The most basic use case for the search bar, is to search sessions of a particular user. Either because that's your testing user or because you're looking for the session of a client who's complaining about your product. If you're setting the user ID when you instantiate the tracker, you'll be able to see the different IDs on the session list.
To do that, when you click on the search bar, select the "User Id" option, as shown below:
When you do that, you'll see the option to specify the user id as part of the filters.
As a note, the full list of filters you have access to is the following:
- Click: filter by where the user is clicking.
- Input: filter by the input used by the user.
- Page: filter by the URI of the page used during the replay session.
- RevId: filter by the revision ID of your app (only if used with the SDK).
- Referrer: The URL from where the user is arriving at your application.
- Duration: filter the replays by their duration.
- User Country: filter by the country of the user interacting with your app (calculated using their public IP address).
- Custom Events: filter by the custom event triggered from the SDK.
- Network Request: filter by the properties of the request issued by the UI (payload, URL, etc).
- GraphQL: filter by the properties of the GraphQL query (name, method and payload).
- StateAction: filter by the action on the state store (i.e Redux, VueX, etc).
- Error: filter by Error Message (i.e the message used when throwing an exception)
- Issue: filter by issue type (Click Rage, Dead Click, Excessive Scrolling, Bad Request, Missing Resources and Memory).
- User OS: filter by the OS of your users.
- User Browser: filter by the name of the browser used by your user (only filters by actual data, so if you can't find results by searching for "Chrome" it means none of your users are using it).
- User Device: filter by the mobile version of the device used by the user.
- Platform: filter by the platform used by your user (either Mobile, Tablet or Desktop).
- User Id: filter by the ID of your user (set with the
- DOM complete: filter by the time it takes for the DOM Complete event to be triggered.
- Largest contentful paint: filter by the time it takes for the DOM Complete event to be triggered.
- Time to First Byte: filter by the time it takes for the to be triggered.
- AVG CPU Load: filters by the average CPU load during the session.
- AVG Memory Usage: filters by the average memory usage during the session.
- Failed Request: Boolean, filters the sessions that do not have failed requests.
Moving on, by default the filter will try to match the exact word you put in there. That's because of the "is" modifier next to the input field. You can change that to other behaviors, such as:
- is any
- is not
- starts with
- ends with
- not contains
- is undefined
For our example, we're going to leave it at "is" since we know the exact email address of our user. As you can see in the following image, when we filter by id "firstname.lastname@example.org" we get only those results:
But what if we want more?
Adding multiple steps to our search
What if we want to search for sessions where the user clicks a particular link, and then the app sends a request to a particular endpoint and finally we get a specific response code back from the server?
Individually each condition is not that complex, but we're looking for all of them together. That's not a problem for our Omnisearch On the left bottom corner of the filter section, you have the "+ADD STEP" option to add multiple factors to the filters.
When you click on it, you'll see the same options you see when clicking on the search bar. Here you'll be able to pick all options however you think you should construct the search.
In our case, we want to search for:
- A particular user id.
- All sessions with a click on a specific link.
- All sessions with requests to one particular URL.
- Finally, all sessions sharing the same family of status codes.
When you tie all these filters together, you get a complex search filter that matches your particular sessions. Let's take a look at what that would look like in the UI:
There are several things to note here:
- The user id is treated as a normal filter while the rest of the parameters are treated as events. This is because you can also specify the order in which these events take place (and the user id will always be there).
- The click event is specifying the text on the button we're clicking (notice the "Get me something!" string). This will autocomplete once you start typing.
- The modifier on the URL is changed from "is" to "contains". This is important because the autocomplete will not take into account URL parameters, but as part of this request, we're sending all attributes from the form as URL parameters (i.e it's a GET request). That way we can encompass all requests, no matter the combination used.
- We've changed the modifier for the "status code" value from "=" to "<" because I'm looking for all success response codes (2XX).
- Notice the "AND" highlighted on the top right corner next to "OR" and "THEN". That modifier makes it so all steps and filters are evaluated with an AND. We could change them to an OR (for example), if we wanted them all to be evaluated individually.
You can change filters around, or even boolean conditions to make your filter exactly how you need it.
But what if your search requires multiple steps? What if you're looking for sessions that conform to a certain funnel? Let's take a look at how you can set a multi-step funnel with the search filters.
Creating a funnel from the search filters
A funnel is nothing more than a set of steps your users have to go through to get to some point. Usually when that happens some users will not go through, perhaps because they lost their interest or perhaps due to errors in your application. And it is for the second scenario that OpenReplay can help you identify issues.
The first thing to do is to define the funnel using the OmniSearch. To do that, simply state the steps required using the many filters listed above.
For our example, I'm going to search for sessions in which the following happens:
- The user is visiting the home page of my app (URI being "/").
- The user interacts with the "first name" input field.
- The user then clicks on the "second page" link.
- The user is taken to a different page with URI "/second-page".
- The user then clicks on the link "Home page".
As you can see, the list of steps can be any random combination that makes sense within your app. This particular example would look like this:
By itself this search would list the sessions that match the pattern. However, we can take this a bit further by saving it as a funnel and then analizing the insight gathered by OpenReplay.
Clicking on the "Save funnel" will prompt you to add a name to your funnel and it'll appear on the lower left corner of the screen.
And once you enter the funnel, you'll get an overview of what happens during the funnel:
As you can appreciate, in this example we can see issues with Dead Clicks and Click Rages in 3 different sessions.
Saving your filters
This functionality makes sure you're not having to re-create your complex filters every time you want to use them. And doing so it's extremely easy.
Say we have a filter that only shows sessions with dead clicks (clicks that don't do anything) on the home page. We want to keep that search so we can constantly check whether new issues like this appear in the future. All we need to do, is set it up, and click on the "SAVE SEARCH" link in the lower right corner of the search box. As seen in the following image:
Give it a name and click on the "Create" button.
After that, your saved search will appear next to the search bar, like so:
The Omnisearch provides you with search superpowers, but to take advantage of them, you have to pick the right options.
Do you have questions?
If you still have questions, make sure to reach out to our devs on our.