Google Tag Manager

Google Tag Manager loads OnyxMetric through a Custom HTML tag that fires on All Pages, so nothing in your site's code changes. Events you already push to the dataLayer can be forwarded to OnyxMetric with one more tag.

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

Track custom events

Once the loader tag is published, window.onyx is available to your own JavaScript and to other GTM tags.

Forward dataLayer events

If your site already pushes events like dataLayer.push({ event: "signup" }), one tag can forward them:

1. Create a Custom Event trigger. Set the event name to a regex such as signup|purchase|add_to_cart and tick Use regex matching.
2. Create a Custom HTML tag on that trigger:

<script>
  if (window.onyx) {
    window.onyx.event("{{Event}}", {
      page: "{{Page Path}}",
      referrer: "{{Referrer}}"
    });
  }
</script>

{{Event}}, {{Page Path}}, and {{Referrer}} are GTM built-in variables. Add a Data Layer Variable for any custom field you push (for example plan) and reference it the same way.

Use click and form triggers

The same pattern works with GTM's built-in Click and Form Submission triggers:

<script>
  if (window.onyx) {
    window.onyx.event("cta_clicked", {
      text: "{{Click Text}}",
      url: "{{Click URL}}"
    });
  }
</script>

Enable the Click Text and Click URL built-in variables under Variables → Configure.

Troubleshooting

• Event tag fires before OnyxMetric loads: the loader is async, so an event tag on the same page load can run first and hit the if (window.onyx) guard. Use tag sequencing so the event tag fires after the loader.
• Consent mode: if your container gates tags on consent, put the loader in the same consent group as your other analytics tags. Otherwise it never fires.
• Tag works in Preview but not live: the container version was not published. Click Submit and publish.

Next steps

• Track custom events such as signups, purchases, and clicks.
• Identify users to tie sessions to accounts.
• Proxy the script through your own domain to get past ad blockers.
• Script attributes let you skip or mask URLs and tag events.