OnyxMetric
Integration GuidesSvelte

Svelte (Vite / Client-Side)

Add OnyxMetric analytics to your Svelte app

A client-side Svelte app from Vite (npm create vite@latest -- --template svelte) has one index.html at the root. Add the tag there for every route.

Copy your tracking snippet

In OnyxMetric, open your site's Site Settings and copy the tracking script. It looks like this:

<script src="https://app.onyxmetric.com/api/script.js?siteId=YOUR_SITE_ID" async></script>

YOUR_SITE_ID is the numeric ID of your site.

Add the snippet to Svelte (Vite / Client-Side)

Open index.html and add the tag inside <head>:

index.html
<head>
  <meta charset="UTF-8" />
  <link rel="icon" type="image/svg+xml" href="/vite.svg" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>My Svelte App</title>
  <script src="https://app.onyxmetric.com/api/script.js?siteId=YOUR_SITE_ID" async></script>
</head>

Placing it before </body> also works, but <head> starts loading sooner.

Check that it works

Load your live site and click through a few pages. Pageviews show up in the OnyxMetric dashboard within seconds.

If nothing arrives:

  • View the page source and search for script.js?siteId= to confirm the tag is present.
  • In the browser's Network tab, check that script.js returns 200 and that requests go to /api/track.
  • Turn off ad blockers, or proxy the script through your own domain.
  • Read script troubleshooting for other causes.

Track custom events

src/lib/ActionButton.svelte
<script>
  function handleAction() {
    window.onyx?.event("user_action", { component: "ActionButton" });
  }
</script>

<button on:click={handleAction}>Perform action</button>

Troubleshooting

  • Missing pageviews after navigation: the script follows History API and hash navigation, which covers svelte-routing and svelte-spa-router. If a route change is still missed, call window.onyx.pageview() from your router's navigation hook.

Next steps

On this page