Verify DataSag analytics on Material for MkDocs

Start with the Material for MkDocs installation

Configure a local theme custom_dir and extend base.html in overrides/main.html. Add the deferred tracker inside an extrahead block while preserving parent content with super(). Merge these changes into your existing MkDocs configuration, build the site and inspect the generated document. Do not edit the installed theme package.

Material may use instant navigation, which changes the reading experience without a complete document reload. Install the global tracker once and test actual path changes. A replacement block that omits parent content can remove unrelated theme functionality.

Use the public project key from the DataSag project you are inspecting. A test on a preview domain does not confirm that the production domain has the same code or settings.

Verify DataSag analytics in Material for MkDocs

1. Check the active mkdocs.yml for the theme custom_dir, then inspect that directory's main.html override. The extrahead block should include the tracker and preserve parent output rather than replacing the complete base template.
2. Run the normal MkDocs production build and serve the resulting site at its real base path. Inspect a generated content page for the public key and pageview request; editing an override outside custom_dir does not affect the output.
3. If instant navigation is enabled, follow a documentation link and use Back. Inspect the tracked pathname without expecting a fresh script download. Heading anchors and search interactions on the same path are separate measurement questions.

The configured theme override reaches generated pages, and direct loads plus enabled instant navigation are checked explicitly.

Complete the collection checks

1. Open the published website in a normal browser window with the Network panel recording. Use a browser profile where you can control extensions and your consent choice.
2. Filter network requests for tracker.js. Confirm it returns JavaScript successfully and that the rendered script has the project's data-datasag-key attribute. The example YOUR_PUBLIC_KEY must be replaced.
3. Filter for /api/track and reload once. Inspect a request with eventName null or absent. Its projectKey and path should match the chosen project and the page you opened.
4. Open that DataSag project, choose a date range containing today and inspect the matching path. Use the configured report timezone when checking dates.
5. Navigate to a second path, then use Back. Compare pageview requests with the route changes rather than counting every request as a pageview.

document.querySelectorAll('script[data-datasag-key]').length
// Expected: 1

document.querySelector('script[data-datasag-key]')?.getAttribute('data-datasag-key')
// Expected: your project's public key

typeof window.datasag?.track
// Expected after the script runs: 'function'

What a successful check looks like

One rendered tracker installation, a successful request for the intended page and a corresponding entry in the intended project. Scroll and engagement requests are separate event types.

Record the public path you tested, the browser state, the approximate time and the observed request. Check one direct page load and one later navigation so the result covers more than the homepage.

Common mistake

A successful tracker.js download only proves that a file loaded. It does not validate the project key, consent state or tracking endpoint. Test a real published path before declaring setup complete.

Installation snippet for Material for MkDocs

The shared installation belongs in an extrahead block in a theme override. Use this as the installation reference while checking the procedure above.

# Merge into mkdocs.yml:
theme:
  name: material
  custom_dir: overrides

<!-- overrides/main.html -->
{% extends "base.html" %}
{% block extrahead %}
  {{ super() }}
  <script defer src="https://www.datasag.com/tracker.js" data-datasag-key="YOUR_PUBLIC_KEY"></script>
{% endblock %}

Related Material for MkDocs guides

• Fix DataSag analytics not working
• Fix duplicate analytics pageviews
• Track custom events
• Track UTM campaigns
• Measure AI referral traffic
• Configure CSP for DataSag analytics
• Exclude your own analytics visits
• Load analytics without blocking rendering

Full Material for MkDocs setup guide · Search and AI visibility

References

Official Material for MkDocs documentation covers the integration point. For DataSag data handling, read the privacy policy. Use support if a request fails after these checks.