Unagi/Docs
Documentation
Get Unagi running on your site in a few minutes.
Quick start
- Create an account and add your site (just its domain, such as
example.com). - Paste the script tag from Settings → Install on your site into your site's header, before
</head>, on every page:<script async src="https://youok.uk/u.js" data-key="YOUR_SITE_KEY" data-consent="auto"></script> - Connect your cookie banner so Unagi knows when a visitor has accepted:
Unagi.consent(true). - Wait for it to verify. Unagi checks your home page for the script and starts crawling once it finds it.
Findings appear once enough visitors have been tracked. Unagi tells you how many sessions it has seen and how far to trust each finding.
Guides
Install on your platform (Shopify, WordPress, Wix and more)
Install the script
Connect your cookie banner
Tracking orders and custom events
Chat, patterns and email
Verification and the crawler
Frequently asked questions
What gets recorded automatically
| Event | When | Needs consent |
|---|---|---|
| Page view | Every page load and every in-app navigation | No (anonymous without consent) |
| Engaged time and scroll depth | When a visitor leaves a page | Yes |
| Add to cart | A click on a button labelled like "Add to cart", "Add to bag" or "Buy now" | Yes |
| Checkout | Visiting a /checkout page, or a "Checkout" / "Place order" click | Yes |
| Purchase | Visiting a page like /thank-you or /order-confirmation | Yes |
| Search | Submitting a site-search box | Yes |
| Clicks | Button and link labels (up to 100 characters), up to 30 per page. Can be turned off | Yes |
Product name, SKU and price are read from your page's structured data (JSON-LD Product markup or Open Graph product tags).