This page provides instructions on how to enable SearchStax analytics and troubleshoot common issues based on implementation experiences with Drupal search views.

Initial setup and enablement

To set up SearchStax analytics, ensure that the configuration includes the following core components:

• Analytics code: Add the SearchStax analytics code to the required environments.

• Key validation: Verify that the configuration uses the correct analytics keys.

• Shield or HTTP authentication: Deactivate Shield or HTTP authentication to prevent blocked data transmission.

Troubleshooting connectivity issues

If analytics data does not appear in the SearchStax dashboard, evaluate the following potential blockers:

• JavaScript conflicts: Custom site implementations can cause JavaScript conflicts that prevent the SearchStax library from attaching to specific search views.
• The 24-hour rule: Initial connections can require up to 24 hours before data populates in the SearchStax analytics dashboard.
  Note

  After the initial connection is established, analytics typically populate 24 hours after users perform searches.

• Shield module or HTTP authentication: These settings do not affect analytics capturing.

Verify activity manually

To check technical indicators while the dashboard updates, follow these steps:

Monitor the Network tab

Check the Network tab in the browser to ensure the page sends tracking signals:

• Open Developer Tools in the browser.
• Select the Network tab.
• In the Filter or Search box, type track.
• Ensure that an item named track/ includes the following values:
  • Status: 204
  • Type: xhr
  • Initiator: starts with studio-analytics.js

Drupal settings JSON

Check the drupal-settings-json script tag on the page to indicate that data will reach the dashboard:

• Access the Search results page in a browser.
• In the browser menu, select View > Developer > View Source.

• Locate the drupal-settings-json script tag.

  copy

  <script type="application/json" data-drupal-selector="drupal-settings-json">
  {
    "path": { … },
    "pluralDelimiter": "\u0003",
    "suppressDeprecationErrors": true,
    "dataLayer": { … }
    },
    "mytheme": {
      "script_path": "\/themes\/custom\/mytheme\/build\/scripts\/"
    },
    "searchstax": {
       …
      "analyticsUrl": "https:\/\/analytics-region.searchstax.com",
      "analyticsKey": "[SEARCHSTAX_ANALYTICS_KEY]",
       …
    },
    "user": { … }
  }
  </script>

• Ensure that the analyticsUrl and analyticsKey match the values in SearchStax.

SearchStax analytics for Acquia Search

This page provides instructions on how to enable SearchStax analytics and troubleshoot common issues based on implementation experiences with Drupal search views.

Initial setup and enablement

To set up SearchStax analytics, ensure that the configuration includes the following core components:

• Analytics code: Add the SearchStax analytics code to the required environments.

• Key validation: Verify that the configuration uses the correct analytics keys.

• Shield or HTTP authentication: Deactivate Shield or HTTP authentication to prevent blocked data transmission.

Troubleshooting connectivity issues

If analytics data does not appear in the SearchStax dashboard, evaluate the following potential blockers:

• JavaScript conflicts: Custom site implementations can cause JavaScript conflicts that prevent the SearchStax library from attaching to specific search views.
• The 24-hour rule: Initial connections can require up to 24 hours before data populates in the SearchStax analytics dashboard.
  Note

  After the initial connection is established, analytics typically populate 24 hours after users perform searches.

• Shield module or HTTP authentication: These settings do not affect analytics capturing.

Verify activity manually

To check technical indicators while the dashboard updates, follow these steps:

Monitor the Network tab

Check the Network tab in the browser to ensure the page sends tracking signals:

• Open Developer Tools in the browser.
• Select the Network tab.
• In the Filter or Search box, type track.
• Ensure that an item named track/ includes the following values:
  • Status: 204
  • Type: xhr
  • Initiator: starts with studio-analytics.js

Drupal settings JSON

Check the drupal-settings-json script tag on the page to indicate that data will reach the dashboard:

• Access the Search results page in a browser.
• In the browser menu, select View > Developer > View Source.

• Locate the drupal-settings-json script tag.

  copy

  <script type="application/json" data-drupal-selector="drupal-settings-json">
  {
    "path": { … },
    "pluralDelimiter": "\u0003",
    "suppressDeprecationErrors": true,
    "dataLayer": { … }
    },
    "mytheme": {
      "script_path": "\/themes\/custom\/mytheme\/build\/scripts\/"
    },
    "searchstax": {
       …
      "analyticsUrl": "https:\/\/analytics-region.searchstax.com",
      "analyticsKey": "[SEARCHSTAX_ANALYTICS_KEY]",
       …
    },
    "user": { … }
  }
  </script>

• Ensure that the analyticsUrl and analyticsKey match the values in SearchStax.