DataSag guides · Updated 27 October 2026

Track custom events on Astro

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 Astro.

Start with the Astro installation

Paste the external script into the head of the .astro layout used by your pages. Keep its src and data attribute on the actual script element. Use is:inline to make the intent explicit and leave the external tracker outside Astro's script bundling.

A layout only covers pages that use it. Check content collection pages and standalone landing pages too. If using client-side transitions, test a full route sequence rather than assuming a fresh document load every time.

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 Astro

  1. Choose the element or client-side form code that can observe the action. For click intent, add data-datasag-goal to the rendered link or button. That delegated goal avoids a separate custom click listener for the same event.
  2. For a confirmed form outcome, invoke the API from the browser success callback used by your implementation. An Astro server endpoint cannot call the visitor window. Keep browser event work separate from server rendering.
  3. If ClientRouter is enabled, test the action after a transition and after returning to the page. Custom DOM listeners may need lifecycle-aware setup and cleanup; do not attach them on every page-load event without preventing duplicates.

The chosen browser action works on first entry and after Astro transitions without repeated listeners or server-side window calls.

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' });

Attach an event listener in your page script, or add data-datasag-goal to a real button. Bind custom listeners once if your site uses transitions.

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 Astro

The shared installation belongs in the head of your shared .astro layout. Use this as the installation reference while checking the procedure above.

<script is:inline defer src="https://www.datasag.com/tracker.js" data-datasag-key="YOUR_PUBLIC_KEY"></script>

Related Astro guides

Full Astro setup guide · Search and AI visibility

References

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