Review User Visits With the Visit Browser

A user visit is also known as a user session, and represents the period in which a user remains active on a website (see What’s a User Visit?). You can use the Visit Browser page to review the visit data for your Coveo search solution. You can also use this page for various purposes, including validating an implementation from a quality assurance perspective, or making sure that all events are logged properly. It also provides a way to select visits that meet certain criteria (e.g., visits in which a case deflection (action) occurred), and review the events, in order of occurence, for each visit.

By default, the Visit Browser page shows 50 visits per page and 250 events per visit. However, all events that occurred in the visits are available when you export the visit data (see Usage Analytics Data Exports).

  • You can’t remove events from a visit. Either the visit contains an event that matches the specified criteria or the visit is filtered out.

  • The Visit Browser page is updated live to show the latest visits.

Review Search Usage Data by Date Interval

On the Visit Browser page, you can quickly switch from the current selected date interval (last week, month…) to the previous period or next period by clicking Previous and Next respectively in the upper-right corner.

  • You can select a period that’s incomplete (e.g., the current month), in which case your date range selection will always include the latest available visits until the period ends (e.g., the first day of the following month).

    For example, you’re reviewing data per Month and want to see how visits are trending for the first two weeks of the current month, so you click the right arrow icon.

  • The date range can’t exceed 365 days.

Alternatively, you can click the box containing the actual date range to access the Report Period dialog, and then select the date range you want to review.

Report period Gif

Add Visit Filters

There are several ways to filter out irrelevant visits and to keep only those you want to review. You can add inclusion and exclusion filters, or a combination of both. When you only add exclusion filters, all visits are shown, except those containing an event that meets your criteria.

Permission filters act as inclusion filters if at least one event during a user visit matches the filter. Therefore, it’s not recommended to use permission filters to filter out user visits.

For example, the permission filter Custom Event Value is not Case Deflection will still show visits in which a case deflection occurs if another custom event was performed during those visits. Therefore, you should instead use exclusion filters to filter out visits containing specific events.

Add Inclusion Filters

  1. On the Visit Browser page, when you want to add an inclusion filter, click an event under Show visits containing, and then select one of four event categories (an event, a search event, a click event, or a custom event).

  2. Click Add-Filter to access the dialog to add global dimension filters, and then select the criteria you want.

    Admin-VisitBrowserFiltExd

    Once created, the filter appears in the top bar under Show visits containing and only the user visits meeting your criteria appear.

Under Show visits containing, when you add a filter with a negative operator (e.g., is not or doesn’t contain), the filter acts as an exclusion filter rather than an inclusion filter.

For example, you want to review visits that contains events of users that aren’t from New York with the following filter: an event where City is not New York. Therefore, all visits from New York users will be excluded.

Add Exclusion Filters

  1. On the Visit Browser page, select the Exclude visits containing check box.

  2. Click an event, and then select between four event categories (an event, a search event, a click event, or a custom event).

  3. Click Add-Filter to access the dialog to add global dimension filters, and then select the criteria you want.

    • To analyze user sessions containing a specific user query that doesn’t contain a support case, select the check box to add the following filter:

      Admin-VisitBrowserExclFiltersb

    • To determine the site visit activities of a user who never uses the search bar, you’ll need to exclude all visits containing a user query.

    Once created, the filter appears in the top bar under Exclude visits containing and only the user visits meeting your criteria appear.

Add Multiple Filters

You can add filters to apply on multiple event categories by clicking And at least and following the same steps as adding inclusion or exclusion filters. Once created, the visits that appear will then match the multiple parameters.

You want to browse user visits in which an item was opened and a case deflection occurred.

Admin-VisitBrowserFiltExe

When adding multiple filters to a single event category, the AND operator is used.

Hide Events

  1. When you want to discard events from remaining visits, select the Hide events check box, and then click Add-Filter to add global dimension filters.

    You want to focus solely on search events returning results to see, over a visit, whether users are clicking results. Therefore, you remove search events without results by adding the following filter: Has Results is False.

  2. You can add alternative filters by clicking Or where. Events matching one of these filters will be hidden.

    Admin-VisitBrowserHideEvents2

Once created, the filter(s) appear(s) under Hide Events, and the events meeting your criteria are excluded.

If a visit has only one event and this event is filtered out, the visit will be hidden as well.

Leading Practices

  • Once you’re done with the filters, you can bookmark the web page or copy and paste the URL in the place of your choice to be able to later access the same state of the Visit Browser page.

  • You can add a named filter with the current filters on a line:

    1. At the right-end of the bar, click Filter-Action, and then select Save filter as or Save filters as.

    2. In the Save as a Named Filter dialog, in the first input, enter a meaningful Filter name, and then click Save.

    The named filter is now applied to the user visits.

  • You can remove all the filters on a line, at the right-end of the row, by clicking Filter-Action, and then selecting Remove filter or Remove all filters.

Browse User Visits

  1. On the Visit Browser page, after setting the date interval and adding filters, click a visit row to view all events that occurred in this particular visit.

  2. Click an event row to view available information on this event, such as dimension values and the response time (see Usage Analytics Dimensions and Reference).

    You can sort events in a visit by Order and Time.

    You can check that events are logged properly by ensuring the metadata of each event is complete and valid.

Export Visit Data That Meet Your Criteria

  1. On the Visit Browser page, click Export in the upper-right corner.

    If the Export visit data using current filters icon is grayed and unresponsive, you don’t have the required privileges to perform this action.

  2. In the Export Estimate dialog that appears and shows the number of events to be contained in the export, click Add an Export.

    The export is created and available for download on the Administration Console Data Exports page.

    When the export contains more than 3 millions events, the events are sorted randomly rather than by date and time.

  3. In the navigation bar on the left, under Analytics, select Data Exports.

  4. On the Data Exports page, click the newly created export, and then in the Action bar, click Download to get the ZIP file on your computer.

After the visit data has been exported, the order of the columns may be rearranged in a spreadsheet in which the corresponding CSV file has been imported.

Review a Visit with More Than 250 Events

To review a single visit containing more than 250 events, you must export the visit data as follows:

  1. On the Visit Browser page, click a visit containing more than 250 events.

  2. Under the 250th event, click Create.

  3. In the Export Estimate dialog that appears, check the Use Dimension Display Names box if you want the export to show the dimension names as they appear in usage analytics reports.

    Origin 1 (Page/Hub)

    By default, exports show the dimension API names.

    For example, originLevel1.

  4. In the navigation bar on the left, under Analytics, select Data Exports.

  5. On the Data Exports page, click the newly created export, and then in the Action bar, click Download to download the ZIP file on your device.

    The export contains all missing events.

Reference

The body of the Visit Browser page is essentially a table listing all the visits that match specific criteria.

When no values are returned for a given field, n/a is shown in the column row.

Start Date Column

Indicates the date and the hour when the user performed their first event on the search interface.

Visit Duration Column

Indicates the time between the first and last event performed by a user during a visit (based on the event visit ID).

  • When hovering the column value, you can see the start and end time of the user visit.

  • An n/a value means that the related visit only contained one event, therefore preventing Coveo Usage Analytics (Coveo UA) to calculate the actual visit duration.

User Name Column

Indicates the user’s display name, if they were authenticated to the search interface when they performed the event.

Location Column

Indicates, when available, the country, province/state, and city from which the user performed the event, based on their IP address.

The location of the user can be n/a, when the IP address is hashed, for example.

Browser Column

Indicates, when available, the web browser name and version with which the user performed the event. This information is extracted from the HTTP user agent identification.

The browser of the user can be n/a, when the user is a custom bot or a crawler, for example.

Event Count Column

Indicates the number of events that occurred in the visit.

Visit Row

When expanding a visit row, the All Visit Events table columns indicate general information about each performed event:

Order

Indicates the rank of the event.

Time

Indicates the time at which the event was performed

User Name

Indicates when the user is authenticated to the search interface, the display name of the user that performed the event

Type

Indicates the type of the event, which can be Click, Search, or the name identifying the custom event or its category

(For custom events only) You can use the Type values when filtering on the Event Type dimension.

Cause

Indicates (for click and search events only) the name of the search or click event cause and Search Cause.

Details

  • For search events, the details indicate the query text entered by the user in the search box (if any), or the selected facet value and the underlying advanced query expression.

  • For click events, the details indicate the title and URL of the item on which the user performed the click.

  • For custom events, the details indicate the name of the custom event cause.

You can use the Details values when filtering on the Event Value dimension.

Event Row

When expanding an event row, you can see all the dimensions and their values passed along with the performed event indicating the context of the recorded event (see Usage Analytics Dimensions).

Required Privileges

The following table indicates the required privileges to view and to edit elements of the Visit Browser page.

Action Service - Domain Required access level
View user visits

Analytics - Analytics data

Analytics - Dimensions

Analytics - Named filters

Analytics - Permission filters

View
Export visit data

Analytics - Analytics data

Analytics - Dimensions

Analytics - Named filters

Analytics - Permission filters

View

Analytics - Data exports

Edit
Recommended Articles