Platform integration

Download PDF

This short guide is for product and engineering teams that run a multi-tenant SaaS or website builder and want to offer privacy-first analytics without extra setup screens. Your users will see a single Enable Simple Analytics checkbox in their account settings, and once they tick it the platform does the heavy lifting.

Under the hood you inject one lightweight script into each customer site, using the site’s hostname as the identifier. There is no need for a separate Simple Analytics account (at the time of installation) or manual site ID, which keeps onboarding fast. If a user later unticks the box, you simply stop embedding the script so tracking halts immediately.

Optionally you can include a small helper that buffers event calls. It sits harmlessly in every page, and when the main script is active it ships events like click_signup to Simple Analytics.

UI integration

Add an Enable Simple Analytics checkbox in your settings page.

When the user checks the box, inject the embed script below into their pages.
When the user unchecks, remove the script.

Simple Analytics integration in your platform

Usually it’s just a user or team setting in your platform.

Embed script

The only thing that’s required, is enabling this script somewhere in the <body> (or <head>) of your platform when your user enables the Simple Analytics Enabled checkbox. They don’t need to enter a website ID and don’t need to create a Simple Analytics account before this checkbox can be enabled. We use the domain as an identifier.

<!-- Simple Analytics platform integration -->
<script async data-hostname="<customer_domain>" data-platform="<your-platform-name>" data-affiliate="<affiliate-code>" src="https://scripts.simpleanalyticscdn.com/latest.js"></script>

<customer_domain> (required) is the stable identifier you create for that site on day one. Usually this is customerxxx.yourplatform.com, or customerdomain.com. Keep it even if the user changes domains later. It’s also the hostname the Simple Analytics users will see in their dashboard.
<your-platform-name> (required) is a unique name of your platform (eg.: netlify, partner.com, kennis.shop). This helps us linking all domains to your platform. Allowing us to give your users tailored instructions.
<affiliate-code> (optional) is a unique code you can get from us which we use to attach it to every hit so new sign ups are credited to your account. This is optional.

Optional event tracking

This part is completely optional, but some users like it when implemented. You can track clicks on buttons, submitting of forms, or clicks on download links.

Add this helper once in <head>. You can include it for every customer. If the Simple Analytics script is not enabled the events remain in the browser and are ignored. When the script is enabled they are automatically sent to Simple Analytics servers.

<script>
window.sa_event = window.sa_event || function () {
  const a = [].slice.call(arguments);
  window.sa_event.q ? window.sa_event.q.push(a) : window.sa_event.q = [a];
};
</script>

Front end events send with this function:

sa_event("click_signup");

How to implement it server side

curl -X POST https://queue.simpleanalyticscdn.com/events \
-H "Content-Type: application/json" \
-d '{
  "type": "event",
  "hostname": "<customer_subdomain>.example.com",
  "affiliate": "affiliate-code",
  "event": "click_signup",
  "ua": "<user_agent>"
}'

Testing

Spin up a test site.
Enable the checkbox.
Visit the test site.
Check if there are requests to Simple Analytics in the Network tab of the Developer Tools.

Platform integration

UI integration

Embed script

Optional event tracking

Testing

Support