Debug tracking issues

This is for:

Business Analyst System Administrator

To confirm that data tracking is correctly implemented, verify the following items, assuming that you’re using the latest version of the Coveo UA library:

  1. Open a Coveo-powered search page.

  2. Open your web browser’s developer tools.

    Note

    The examples in this article use the Google Chrome developer tools. For browser-specific information, see:

  3. In the Application tab of your developer tools, check whether there’s an identifier in local storage with the attribute name visitorId. Cookies and local storage are typically found under a separate tab (for example, Local Storage).

    For example:

    Identifier in developer tool

  4. Verify that the same identifier has been stored in a local cookie with the attribute name coveo_visitorId, and that it’s scoped to the top-level domain of the main page. In the following example, the https://search.cloud.coveo.com search page is used, therefore the top-level domain is .coveo.com.

    Identifier stored in local cookie shown in browser developer tools
    Note

    If you notice that you have the visitor cookie on analytics.cloud.coveo.com, you can ignore it. This is a legacy third-party-cookie set by Coveo Usage Analytics (Coveo UA).

    For example:

    Visitor cookie in developer tool

  5. In the Network tab, verify whether this same identifier is being set on calls.

    • When inspecting calls to the search API endpoint (rest/search/v2), the same identifier should be visible under analytics.clientId or visitorId.

      Network panel showing identifier calls in browser developer tools

    • When inspecting calls to the analytics API endpoints (rest/ua/v15/analytics), the same identifier should be visible under cid for the collect endpoint, or under cliendId in the payload or the URL visitorId parameter for other endpoints.

      Network panel showing identifier calls in browser developer tools