Auto Capture

This guide will explain how to configure auto capture using the SeaUrchin.IO dashboard. Using this config-driven system, SeaUrchin.IO can track all search activity on a site without any custom code.

Search Flow

If any of these fields are not applicable your site's search flow, just leave it blank.

Search URL

  • Search URL

    URL used to return search results. The URL should be as specific as necessary to prevent false positives. RegExp match.

    This field is used to match against each of the following search paradigms:

    • Form Submits

      This property matches against the full page URL after the form submit navigation happens.

    • AJAX Requests

      This property matches against the AJAX URL string specified by your site's JavaScript code instead of the fully qualified path.

      For example, an AJAX request made this way will match search, but not /search:

      $.ajax({
          url: "search",  // not a root-relative path
          data: ...
      });
    • JSONP API Calls

      This property matches against the script src attribute for the JSONP call.

  • Query Parameter

    Name of query parameter sent to the search URL.

    • Query as part of URL parameter

      q for example.com/search?q=<query>

    • Query as part of URL path

      /search/([^/]+) for example.com/search/<query>/

      The value in the last () capture group will be extracted as the query.

    • Query as part of JSON POST body

      q for { "q": "<query>" }

    • Query as part of URL encoded POST body

      q for q=<query>

  • Offset / Page Parameter

    Name of offset / page parameter sent to the search URL. See "Query Parameters" section above.


Result Container

CSS selector for the DOM element holding each individual search result (ex: .container .result). The selector should be as specific as necessary to prevent false positives.


Item URL

URL pattern for item pages. Used to track direct hits and result dwell time. RegExp match.

Usually, this page is one of the many displayed for users to choose from after a search. The URL should be as specific as necessary to prevent false positives.


Flow Goals

Track conversion goals specific to this search flow. App-level conversion goals should be configured on the "App Settings" page, and will automatically apply to all search flows.

  • URL goal

  • Click goal

  • Checkout goal

It may take a few minutes before data starts showing up in the dashboard.

Event Debugger

After creating a search flow, you may want to verify that the correct events are being captured. To see a running log of search events captured by your browser, use the SeaUrchin.IO Event Debugger bookmarklet.


SeaUrchin.IO Event Debugger


Usage directions:

  1. Drag the button above into your browser's bookmarks bar.
  2. Click it on any page containing the SeaUrchin.IO tracking code to bring up the debug panel.
  3. Perform some search-related actions in your browser.
  4. The debug panel will log all events captured as a result of your actions.

Usage tips:

  • To distinguish between multiple search flows, look at the flow id of each event (the "f" field).
  • For more information about event data, see the data format documentation.
Can't find what you're looking for? Send an email to support@seaurchin.io