Reviewing Incoherent Usage Analytics Events

Administrators can use the Incoherent Events page to review the list of usage analytics events discarded by Coveo Usage Analytics (Coveo UA) (see Built-In Groups). With this list and the JSON description of the incoherent events, as an administrator, you can capture potential implementation issues, and then fix the underlying causes.

It is recommended to consult this page regularly during integration testing to quickly identify malformed events sent by your application.

Access the “Incoherent Events” Page

  1. If not already done, log in to the Coveo Cloud platform as a member of a group with the required privileges.

  2. In the main menu on the left, under Analytics, select Incoherent Events.

Inspect Incoherent Events

On the Incoherent Events page, in the table, you can review the history of incoherent events within your organization analytics data.

  • In the Action bar, click the date range to open a date picker dialog:

    1. In the calendar, click a start date and an end date within the last three years.

      OR

      Under Date range, click one of the suggested time windows: Last day, Last week, Last month, or Last year.

      OR

      Use the start and end date inputs to enter a valid datetime value in the following format: yyyy-mm-dd hh:mm

      You can also click the set to now icon (Icon-Settonow) that automatically enters the current datetime.

    2. Click Apply to apply your time window choice and close the date picker dialog.

    • The longest time window you can select is three years.

    • Next to the start date (first) and end date (second) boxes, you may click the Set to now button (Admin-LogBrowserCalendarSetToNow) to apply the current date and time to the corresponding box.

  • Use the value of the facets to filter events to the ones you want to review (see Filter Events By Error Code).

  • To copy an event error code, click the desired event, and then in the Action bar, click Copy Code to Clipboard. You can then paste the error code where needed.

  • At the lower-left corner of the page, click 100 to show more events on the page (default is 50).

  • In the lower-right corner, use the Next and Previous links to navigate to other pages and see older or newer events.

</div>

Review Incoherent Event JSON Description

  1. On the Incoherent Events page, find the event that you want to review the description (see Inspect Incoherent Events).

  2. Click the desired event, and then in the Action bar, click View.

  3. In the View an Incoherent Event: [Event_Type] panel that appears, depending on the error code, review the pair of dimensions and values for the incoherent event.

    • The available data in the JSON description differs depending on the event type.

    • You can copy the description in a JSON editor to ease your review.

    When reviewing an event with a duplicate search ID, note the visitId value. You can then look in the Visit Browser using the visit ID to find the event that has same search ID (see Reviewing User Visits With the Visit Browser).

    The JSON configuration can be pretty long. Therefore, you can use the implemented search feature to easily find event description elements such as dimension names and values.

    1. In the JSON description box, fill the Search box with the desired keyword(s):

      1. Click anywhere in the JSON configuration box.

      2. Press Ctrl-F (Windows) or cmd-F (Mac).

      3. In the Search field that appears at the top of the box, type the desired keyword(s) or regular expressions (regex), and press Enter.

      OR

      In the JSON description box, select the keyword(s) you want to search, and then press Ctrl-F (Windows) or cmd-F (Mac).

      The selected keyword(s) automatically appears in the Search box

    2. Press Enter.

      When present, the keyword occurrences are highlighted with a yellow background. The box content scrolls when needed to ensure the first keyword occurrence is visible.

    3. Repeat steps 1 and 2 to automatically scroll in the JSON description box to review the other keyword occurrences.

Filter Events By Error Code

The Incoherent Events page has a facet on the left-hand side of the page. This facet allows you to filter incoherent events by selecting the error code of the events you want to show. The Error Code facet displays the options you can choose from (see Reference).

You want to review the events that failed to meet the strict validation rule requirements. On the Incoherent Events page, in the Error Code facet, you select the Strict validation failure check box.

  • You can select more than one value per facet.

  • The number of events per error code is shown next to each facet value.

  • Once the focus is in a facet check box, you can press the Tab key to navigate between facet values, and then press the Space or Enter key to select values.

  • Clear your facet value selection by clicking the X icon at the top-right corner of the facet box.

Reference

The information you can review in the page table is:

  • Type column

    The possible analytics event types are Click, Search, Custom, and View (see Usage Analytics Recorded Events).

  • Datetime column

    • Event date and time
  • Error Code column

    The errors can be client or server side. For instance, your application can send two search events when a user performs a query (client side) or two click events when a user clicks a search result (server side). The possible error codes are:

    Error Code Description Actionable Error
    Duplicate view event

    A view event with the same view ID was already logged in the database that was rejected by Coveo UA to avoid duplicate events.

    The view event ID is generated server side, meaning that the error is internal.

    This error has no impact on your usage analytics data.

    Click without associated search

    A click event was sent with a search query UID that does not correspond to a valid search event.

    Review your integration and ensure the click event uses the search ID returned by the search event call (see Add a click event via POST).

    Duplicate click

    A click event with the same click ID was already logged in the database that was rejected by Coveo UA to avoid duplicate events.

    The click event ID is generated server side, meaning that the error is internal.

    This error has no impact on your usage analytics data.

    Duplicate custom event

    A custom event with the same custom event ID was already logged in the database that was rejected by Coveo UA to avoid duplicate events.

    The custom event ID is generated server side, meaning that the error is internal.

    This error has no impact on your usage analytics data.

    Duplicate search

    A search event with the same search ID was already logged in the database that was rejected by Coveo UA to avoid duplicate events.

    This event ID is provided client side.

    • The error can also occur for a custom event with the last search ID of a search event that was rejected for being a duplicate.

    • The error can also occur, in rare cases, due to an internal issue.

    Depends on the cause*
    Strict validation failure (When strict validation is applied in your organization) An analytics event was rejected because they contained suspect dimension values (see Strict Validation).

    * Only actionable when the error is client side.

Required Privileges

The following table indicates the privileges required to view or edit elements of the Incoherent Events page and associated panels (see Privilege Management and Privilege Reference).

Action Service - Privilege Required access level
View incoherent events

Analytics - Incoherent events

Organization - Organization

View