DataSag guides · Updated 27 October 2026

Track custom events on VitePress

Use data-datasag-goal for a click goal, or call window.datasag.track after a completed action. Choose a stable event name and distinguish a click from a successful conversion. This guide applies to VitePress.

Start with the VitePress installation

Merge a script tuple into the global VitePress head array. Include the external src, an empty-string defer attribute and the public data-datasag-key. Preserve other head entries, build the documentation and inspect its published HTML. Global config covers ordinary pages generated from that site.

VitePress also supports page-level head entries in frontmatter and custom theme code. A global script plus page or theme insertion can execute twice. Browser APIs belong in browser interaction code, not the Node-evaluated site configuration or an SSR render.

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.

Track custom events in VitePress

  1. Choose the Vue component or HTML element that owns the interaction. Use data-datasag-goal for a simple click goal, or invoke the existing API from a browser handler after the application confirms the requested action.
  2. Keep browser event code separate from the Node-evaluated VitePress config and server-rendered component setup. If you add DOM listeners in a mounted component, remove them when that component unmounts during documentation navigation.
  3. Test the same component after direct entry and after visiting another document and returning. One action should emit the agreed event once. A click on an external service still cannot establish that the service completed a signup.

The Vue interaction emits one browser event after the intended boundary without accumulating listeners across documentation routes.

Complete the collection checks

  1. Write the event definition first. For example, signup_click means a visitor pressed a signup link, while signup_completed means your application confirmed account creation.
  2. For click intent, add data-datasag-goal to the element. The tracker delegates clicks, so you do not also need a JavaScript handler for the same goal.
  3. For a completed action, call the JavaScript API in the success handler. Wait for the tracker to be available. An optional guard avoids a crash but intentionally drops the event if the tracker has not loaded.
  4. Send only the context needed for the report, such as a form or plan name. Do not include email addresses, passwords, payment details or freeform form contents.
  5. Complete one successful and one failed attempt. Inspect /api/track for the exact eventName and properties. Only the successful attempt should emit a completed-action event.
  6. Check the event report available to your plan. Collection and access to reports are separate; review current plan details before depending on a particular report.
<!-- Click intent: use this OR your own click handler -->
<a href="/signup" data-datasag-goal="signup_click">Create account</a>

// JavaScript: inside the confirmed-success handler
window.datasag?.track('signup_completed', { form: 'main_signup' });

Use a browser-side Vue handler in a custom component, or a goal attribute on markup you control. Call completed-action events after confirmation, and verify that route changes do not accumulate your custom event listeners.

What a successful check looks like

A controlled successful action produces one event with the agreed name. A validation failure does not emit a success event. Network evidence matches the report definition.

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 goal attribute on a submit button measures clicks, including attempts that fail. Do not report those clicks as completed signups or purchases.

Installation snippet for VitePress

The shared installation belongs in the head array in .vitepress/config.ts or its configured equivalent. Use this as the installation reference while checking the procedure above.

// Merge into the existing .vitepress config.
export default {
  head: [["script", {
    src: "https://www.datasag.com/tracker.js",
    defer: "",
    "data-datasag-key": "YOUR_PUBLIC_KEY"
  }]]
};

Related VitePress guides

Full VitePress setup guide · Search and AI visibility

References

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