Simple Analytics

https://docs.simpleanalytics.com
Admin
Simple Analytics is a privacy-friendly and straightforward web analytics platform that offers an...
Tokens:22,737
Snippets:161
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Configure Netlify Redirects for Simple Analytics Proxy

Source: https://docs.simpleanalytics.com/proxy

This example illustrates how to set up proxying for Simple Analytics using Netlify's `_redirects` file. It defines 200-status redirects for `proxy.js`, `auto-events.js`, and the `/simple/*` path to their respective Simple Analytics CDN endpoints. Ensure `example.com` is updated to your domain.

```Netlify Redirects
/proxy.js https://simpleanalyticsexternal.com/proxy.js?hostname=example.com&path=/simple 200
/auto-events.js https://scripts.simpleanalyticscdn.com/auto-events.js 200
/simple/* https://queue.simpleanalyticscdn.com/:splat 200
```

--------------------------------

### Update Simple Analytics Embed Script with Optional Noscript Tag for Proxy

Source: https://docs.simpleanalytics.com/proxy

This example provides the full embed script, including an optional `<noscript>` tag, for use with the Simple Analytics proxy. It's important to note the `/simple` prefix for `noscript.gif` and its absence for `proxy.js` in the main script tag.

```HTML
<script async src="https://example.com/proxy.js"></script>
<noscript
  ><img
    src="https://example.com/simple/noscript.gif"
    alt=""
    referrerpolicy="no-referrer-when-downgrade"
/></noscript>
```

--------------------------------

### Gatsby Simple Analytics Plugin Advanced Configuration

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-gatsby

This configuration example demonstrates how to set a custom domain, enable event tracking, and specify pages to ignore for the Simple Analytics Gatsby plugin.

```JavaScript
plugins: [
  {
    resolve: "gatsby-plugin-simple-analytics",
    options: {
      domain: "custom.example.com",
      eventsGlobal: "sa",
      events: true,
      trackPageViews: true,
      ignorePages: ["pathname"],
    },
  },
]
```

--------------------------------

### Install Simple Analytics via npm

Source: https://docs.simpleanalytics.com/install-simple-analytics-via-analytics-package

This command installs the core 'analytics' library and the specific '@analytics/simple-analytics' plugin using npm, the package manager for JavaScript. This setup allows for easy integration and customization of analytics tracking.

```JavaScript
npm install analytics @analytics/simple-analytics
```

--------------------------------

### Configure Caddy Proxy for Simple Analytics Resources

Source: https://docs.simpleanalytics.com/proxy

This Caddyfile configuration shows how to proxy Simple Analytics resources using Caddy. It defines `handle` blocks for `proxy.js`, `auto-events.js`, and the analytics queue, including stripping prefixes and managing `X-Forwarded-For` headers. Update `example.com` to your actual domain.

```Caddyfile
example.com {
  handle /simple/* {
    uri strip_prefix /simple
    reverse_proxy https://queue.simpleanalyticscdn.com {
      header_up X-Caddy-Proxy "true"
      header_up -X-Forwarded-For
    }
  }
  handle /proxy.js {
    rewrite * /proxy.js?{query}&hostname=example.com&path=/simple
    reverse_proxy https://simpleanalyticsexternal.com {
      header_up -X-Forwarded-For
    }
  }
  handle /auto-events.js {
    rewrite * /auto-events.js
    reverse_proxy https://scripts.simpleanalyticscdn.com {
      header_up -X-Forwarded-For
    }
  }
}
```

--------------------------------

### Configure Simple Analytics VuePress Plugin with Advanced Options

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-vuepress

Example configuration for the Simple Analytics plugin in VuePress, demonstrating how to set a custom domain for bypassing ad-blockers, define the global events object for custom event tracking, and enable tracking for Do Not Track (DNT) users.

```JavaScript
module.exports = {
  plugins: [
    [
      "vuepress-plugin-simple-analytics",
      {
        customDomain: "data.example.com", // You custom domain
        eventsGlobal: "sa", // The global events object for sa("click_button")
        skipDnt: true // When set to true you track the DNT users
      }
    ]
  ]
};
```

--------------------------------

### Configure NGINX Proxy for Simple Analytics Resources

Source: https://docs.simpleanalytics.com/proxy

This snippet demonstrates how to set up NGINX as a reverse proxy for Simple Analytics. It configures specific `location` blocks to proxy `proxy.js`, `auto-events.js`, and the main analytics queue, ensuring proper header forwarding and handling of trailing slashes. Remember to replace `example.com` with your domain.

```NGINX
location ^~ /simple/ {
  proxy_set_header  X-Forwarded-Proto $scheme;
  proxy_set_header  X-Forwarded-Proto-Version $http2;
  proxy_set_header  Host $http_host;
  proxy_set_header  X-NginX-Proxy true;
  proxy_set_header  Connection "";
  proxy_pass_request_headers on;
  proxy_pass https://queue.simpleanalyticscdn.com/;
}

location = /proxy.js {
  expires 7d;
  add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
  proxy_pass https://simpleanalyticsexternal.com/proxy.js?hostname=example.com&path=/simple;
}

location = /auto-events.js {
  expires 7d;
  add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
  proxy_pass https://scripts.simpleanalyticscdn.com/auto-events.js;
}
```

--------------------------------

### Configure Vercel Rewrites for Simple Analytics Proxy

Source: https://docs.simpleanalytics.com/proxy

This `vercel.json` configuration demonstrates how to implement proxy rewrites for Simple Analytics resources on Vercel. It uses `source` and `destination` properties to redirect requests for `proxy.js`, `auto-events.js`, and `/simple/*` to the Simple Analytics CDNs. Remember to customize `example.com` and the `/simple` path as needed.

```JSON
{
  "rewrites": [
    {
      "source": "/proxy.js",
      "destination": "https://simpleanalyticsexternal.com/proxy.js?hostname=example.com&path=/simple"
    },
    {
      "source": "/auto-events.js",
      "destination": "https://scripts.simpleanalyticscdn.com/auto-events.js"
    },
    {
      "source": "/simple/:match*",
      "destination": "https://queue.simpleanalyticscdn.com/:match*"
    }
  ]
}
```

--------------------------------

### Basic Simple Analytics Plugin Setup for Nuxt 3

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-nuxt

This code snippet demonstrates the fundamental setup for integrating Simple Analytics into a Nuxt 3 application. It creates a client-side plugin that registers the `simple-analytics-vue` library with the Nuxt Vue application instance, enabling basic analytics tracking.

```javascript
import SimpleAnalytics from "simple-analytics-vue";

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.use(SimpleAnalytics);
});
```

--------------------------------

### Install Simple Analytics Python package

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-django

Command to install the Simple Analytics Python package using pip, which is the standard package installer for Python.

```bash
pip install simpleanalytics
```

--------------------------------

### Manually Install Simple Analytics Rails Gem

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-ruby-on-rails

Alternatively, you can install the `simple_analytics_rails` gem directly from the command line using `gem install`. This is useful for global installation or testing outside of a Bundler-managed project.

```Ruby
gem install simple_analytics_rails
```

--------------------------------

### Integrate Simple Analytics tags into Django template

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-django

Example of a Django HTML template demonstrating how to load and use Simple Analytics template tags (`simpleanalytics_sync` for JavaScript tracking and `simpleanalytics_noscript_block` for fallback) within your HTML structure.

```django-html
<!DOCTYPE html>
{% load static simpleanalytics_tags %}
<html>
  <head>
    <meta charset="utf-8" />
    <title>{% block page_title %}{% endblock %}</title>
    <meta
      name="viewport"
      content="width=device-width, initial-scale=1.0, user-scalable=no"
    />
    ... {% simpleanalytics_sync %} ...
  </head>
  <body>
    {% simpleanalytics_noscript_block %}
  </body>
</html>
```

--------------------------------

### Install Simple Analytics VuePress Plugin

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-vuepress

Command to install the Simple Analytics plugin for VuePress using npm, saving it as a development dependency.

```Shell
npm install vuepress-plugin-simple-analytics --save-dev
```

--------------------------------

### Install Ruby Gems with Bundler

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-ruby-on-rails

After adding the gem to your Gemfile, run `bundle install` in your terminal. This command resolves and installs all declared gems, including `simple_analytics_rails`, into your project's environment.

```Ruby
bundle install
```

--------------------------------

### Nuxt.js: Simple Analytics Vue Plugin Setup

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-vue

Illustrates the creation of a `simple-analytics.js` plugin file for Nuxt.js. It imports the `simple-analytics-vue` library and registers it with Vue, conditionally skipping tracking outside of production environments to prevent local development data from being sent.

```javascript
import SimpleAnalytics from "simple-analytics-vue";
import Vue from "vue";

Vue.use(SimpleAnalytics, { skip: process.env.NODE_ENV !== "production" });
```

--------------------------------

### Simple Analytics Stats API: Wildcard Search for Paths Starting With

Source: https://docs.simpleanalytics.com/api/stats

API call example demonstrating the use of wildcards ('*') to search for pages whose paths start with a specific string. This allows for flexible querying of data for groups of related pages.

```APIDOC
https://simpleanalytics.com/simpleanalytics.com.json?version=5&fields=pages&pages=/web*
```

--------------------------------

### Combined Simple Analytics Embed and Automated Events Scripts with Proxy

Source: https://docs.simpleanalytics.com/proxy

This code block presents the complete set of HTML script tags required to integrate Simple Analytics with both its main embed and automated events features, all routed through your custom proxy endpoints. It combines the `proxy.js` and `auto-events.js` script references.

```HTML
<script async src="https://example.com/proxy.js"></script>
<script async src="https://example.com/auto-events.js"></script>
```

--------------------------------

### Install Gridsome Simple Analytics Plugin

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-gridsome

Installs the `gridsome-plugin-simple-analytics` package using npm, adding it to your Gridsome project's dependencies.

```Node.js
npm install gridsome-plugin-simple-analytics
```

--------------------------------

### Simple Analytics Embed Script Header

Source: https://docs.simpleanalytics.com/proxy

This snippet shows the expected header comment of the Simple Analytics embed script, which should be returned when accessing the proxy.js file. It indicates the script's privacy-friendly nature.

```JavaScript
/* Simple Analytics - Privacy friendly analytics ... */
```

--------------------------------

### Example CloudQuery Sync Output

Source: https://docs.simpleanalytics.com/export-to-data-warehouse-with-cloudquery

Illustrates the successful output of a CloudQuery sync operation, showing migration and sync completion, resource count, and execution time.

```bash
➜ playground cloudquery sync simpleanalytics.yml sqlite.yml
Loading spec(s) from simple-analytics.yml
Starting migration with 2 tables for: simple-analytics (v1.0.0) -> [sqlite (v1.2.1)]
Migration completed successfully.
Starting sync for: simple-analytics (v1.0.0) -> [sqlite (v1.2.1)]
Sync completed successfully. Resources: 105666, Errors: 0, Panics: 0, Time: 41s
```

--------------------------------

### Initialize Analytics Library with Simple Analytics Plugin (JavaScript)

Source: https://docs.simpleanalytics.com/install-simple-analytics-via-analytics-package

This snippet demonstrates how to import and initialize the Analytics library with the Simple Analytics plugin. It sets up automatic page view tracking for your application.

```javascript
/* src/analytics.js */
import Analytics from "analytics";
import simpleAnalyticsPlugin from "@analytics/simple-analytics";

const analytics = Analytics({
  app: "awesome-app",
  plugins: [
    // Load simple analytics! 🎉
    simpleAnalyticsPlugin(),
  ],
});

/* All page views are now tracked by simple analytics */
```

--------------------------------

### Install Simple Analytics Inline Events Helper Script

Source: https://docs.simpleanalytics.com/events/inline

Include these script tags before the closing </body> tag to enable automatic event tracking based on data-simple-event attributes. This installs both the main Simple Analytics script and the inline events helper.

```HTML
<script async src="https://scripts.simpleanalyticscdn.com/latest.js"></script>
<script async src="https://scripts.simpleanalyticscdn.com/inline-events.js"></script>
```

--------------------------------

### Begin Simple Analytics Rails Gem Initializer Configuration

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-ruby-on-rails

The `simple_analytics_rails` gem allows for custom configuration via an initializer file. This snippet indicates where such a configuration block would begin, enabling advanced settings for the tracking script.

```Ruby

```

--------------------------------

### Install Simple Analytics Docusaurus Plugin via npm

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-docusaurus

This command installs the docusaurus-plugin-simple-analytics package from npm, adding it as a dependency to your Docusaurus project. This is the first step to integrate Simple Analytics.

```Shell
npm install docusaurus-plugin-simple-analytics --save
```

--------------------------------

### Configure Simple Analytics Skip Option with Function or Promise

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-vue

This example shows a more advanced usage of the 'skip' option, allowing a function or a promise to determine when Simple Analytics should be skipped. This is useful for dynamic conditions, such as skipping tracking based on user authentication status or other asynchronous checks.

```JavaScript
import auth from "lib/auth";
Vue.use(SimpleAnalytics, { skip: auth.isAdminPromise });
```

--------------------------------

### Add Simple Analytics to Django INSTALLED_APPS

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-django

Configuration snippet for Django's settings.py file to include the 'simpleanalytics' app in your project, making its functionalities available.

```python
INSTALLED_APPS = [
   ...,
   simpleanalytics,
]
```

--------------------------------

### Example URL with Simple Analytics UTM Parameters

Source: https://docs.simpleanalytics.com/how-to-use-url-parameters

A sample URL demonstrating the use of `utm_source`, `utm_medium`, `utm_campaign`, and a custom `project-id` parameter for tracking purposes within Simple Analytics. This URL shows how marketing campaign data is appended to a landing page link.

```URL
https://example.com/landing-page?utm_source=company-x&utm_medium=newsletter&utm_campaign=march_01&project-id=123
```

--------------------------------

### Install Simple Analytics Vue.js Package

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-vue

This command installs the official Simple Analytics plugin for Vue.js using npm, making it available for use in your project.

```bash
npm install simple-analytics-vue
```

--------------------------------

### Install Simple Analytics via JavaScript

Source: https://docs.simpleanalytics.com/script

This JavaScript code dynamically creates a script element and appends it to the document's head, loading the Simple Analytics tracking script. This method is suitable when direct HTML embedding is not feasible, allowing for programmatic installation.

```JavaScript
// Simple Analytics - 100% privacy-first analytics
const script = document.createElement("script");
script.setAttribute("src", "https://scripts.simpleanalyticscdn.com/latest.js");
document.head.appendChild(script);
```

--------------------------------

### Install Gatsby Simple Analytics Plugin via npm

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-gatsby

Use this npm command to add the `gatsby-plugin-simple-analytics` package as a development dependency to your Gatsby project.

```Shell
npm install gatsby-plugin-simple-analytics --save-dev
```

--------------------------------

### Example Original User-Agent String

Source: https://docs.simpleanalytics.com/metrics

This snippet provides an example of an original user-agent string as reported by a browser or device. User-agent strings are used by browsers or devices to identify themselves to websites, typically containing information about the browser, operating system, and device type.

```text
Mozilla/5.0 (iPad; U; CPU OS 3_2_1) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B40598
```

--------------------------------

### Install Simple Analytics Vue Package

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-nuxt

Command to install the `simple-analytics-vue` package, which provides Vue.js and Nuxt.js integration for Simple Analytics, as a development dependency.

```npm
npm install simple-analytics-vue --save-dev
```

--------------------------------

### Configure Simple Analytics Plugin in Gridsome

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-gridsome

Configures the `gridsome-plugin-simple-analytics` in your Gridsome project's `gridsome.config.js` file, enabling basic Simple Analytics tracking.

```JavaScript
module.exports = {
  plugins: [
    {
      use: "gridsome-plugin-simple-analytics",
    },
  ],
};
```

--------------------------------

### Update Simple Analytics Embed Script to Use Proxy Endpoint

Source: https://docs.simpleanalytics.com/proxy

This snippet shows the basic modification required for the Simple Analytics embed script. It changes the `src` attribute of the `<script>` tag to point to your self-hosted `proxy.js` endpoint, ensuring all analytics traffic goes through your proxy.

```HTML
<script async src="https://example.com/proxy.js"></script>
```

--------------------------------

### Register Simple Analytics Plugin in Docusaurus Configuration

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-docusaurus

After installation, add the docusaurus-plugin-simple-analytics to the plugins array within your docusaurus.config.js file. This activates the plugin for your Docusaurus site.

```JavaScript
plugins: [
  ...
  ['docusaurus-plugin-simple-analytics', {}],
  ...
],
```

--------------------------------

### Update Simple Analytics Automated Events Script to Use Proxy Endpoint

Source: https://docs.simpleanalytics.com/proxy

This snippet demonstrates how to modify the script tag for Simple Analytics' automated events. It updates the `src` attribute to point to your proxied `auto-events.js` endpoint, ensuring event tracking also goes through your custom proxy.

```HTML
<script async src="https://example.com/auto-events.js"></script>
```

--------------------------------

### Basic Gatsby Simple Analytics Plugin Configuration

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-gatsby

Add this configuration block to your `gatsby-config.js` file to enable basic page view tracking with the Simple Analytics plugin.

```JavaScript
plugins: [
  {
    resolve: "gatsby-plugin-simple-analytics",
    options: {
      trackPageViews: true,
    },
  },
]
```

--------------------------------

### Add Simple Analytics Plugin to VuePress Configuration

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-vuepress

Configuration snippet to enable the Simple Analytics plugin in your VuePress `config.js` file, allowing it to be used in your project.

```JavaScript
module.exports = {
  plugins: ["vuepress-plugin-simple-analytics"],
};
```

--------------------------------

### Install Simple Analytics Vue Package for Nuxt 2

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-nuxt

This command installs the `simple-analytics-vue` package, a Vue.js integration for Simple Analytics, as a development dependency using npm. It's the first step to integrate analytics into a Nuxt 2 project.

```bash
npm install simple-analytics-vue@2.x --save-dev
```

--------------------------------

### Configure Simple Analytics Rails Gem

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-ruby-on-rails

This Ruby code snippet shows how to set up the Simple Analytics Rails gem within a `config/initializers/simple_analytics.rb` file. It covers essential configuration parameters such as the tracking hostname, hash mode, Do Not Track (DNT) collection, pages to exclude from tracking, custom JavaScript global variable, automatic page view collection, a JavaScript callback function for onload events, a custom domain for bypassing ad blockers, and conditional enabling based on the Rails environment.

```Ruby
SimpleAnalyticsRails.configure do |configuration|
  # ==> Overwrite domain name
  # https://docs.simpleanalytics.com/overwrite-domain-name
  #
  # Default is ""
  configuration.hostname = "example.com"
  # ==> Hash mode
  # https://docs.simpleanalytics.com/hash-mode
  #
  # Default is ""
  configuration.mode = "hash"
  # ==> Do not track
  # https://docs.simpleanalytics.com/dnt
  #
  # Default is false
  configuration.collect_dnt = false
  # ==> Ignore pages
  # https://docs.simpleanalytics.com/ignore-pages
  #
  # Default is ""
  configuration.ignore_pages = "/search/*,/account/*,/vouchers"
  # ==> Override variable used for JavaScript Events
  # https://docs.simpleanalytics.com/events#the-variable-sa_event-is-already-used
  #
  # Default is "sa_event"
  configuration.sa_global = "sa_event"
  # ==> Trigger custom page views
  # https://docs.simpleanalytics.com/trigger-custom-page-views#use-custom-collection-anyway
  #
  # Default is true
  configuration.auto_collect = true
  # ==> Onload Callback
  # https://docs.simpleanalytics.com/trigger-custom-page-views#use-custom-collection-anyway
  #
  # Default is ""
  configuration.onload_callback = "onloadCallback()"
  # ==> Custom Domain
  # https://docs.simpleanalytics.com/bypass-ad-blockers
  #
  # Default is ""
  configuration.custom_domain = "custom.domain.com"
  # ==> Inject JavaScript To Head
  # You can disable the automatic JavaScript injection if you'd like.
  #
  # Default is true
  configuration.enabled = Rails.env.production?
end
```

--------------------------------

### Include Non-JavaScript Fallback for Simple Analytics (HTML)

Source: https://docs.simpleanalytics.com/install-simple-analytics-via-analytics-package

This HTML snippet provides a fallback image tag for browsers with JavaScript disabled, ensuring basic tracking for Simple Analytics.

```html
<noscript><img src="https://queue.simpleanalyticscdn.com/noscript.gif" alt="" referrerpolicy="no-referrer-when-downgrade" /></noscript>
```

--------------------------------

### Example `curl` command to list websites via Admin API

Source: https://docs.simpleanalytics.com/api/admin

This `curl` command demonstrates how to make an authenticated request to the Simple Analytics Admin API's `/api/websites` endpoint to retrieve a list of all associated websites. Replace placeholder values for `Api-Key` and `User-Id` with your actual credentials found in your account settings.

```bash
curl "https://simpleanalytics.com/api/websites" \
     -H 'Content-Type: application/json' \
     -H 'Api-Key: sa_api_key_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
     -H 'User-Id: sa_user_id_00000000-0000-0000-0000-000000000000'
```

--------------------------------

### Configure Simple Analytics Plugin with Custom Domain in Gridsome

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-gridsome

Configures the `gridsome-plugin-simple-analytics` in Gridsome to use a custom domain for bypassing ad blockers, by setting the `domain` option within the plugin's configuration.

```JavaScript
module.exports = {
  plugins: [
    {
      use: "gridsome-plugin-simple-analytics",
      options: {
        domain: "api.example.com",
      },
    },
  ],
};
```

--------------------------------

### Example CSV output format for Simple Analytics data export

Source: https://docs.simpleanalytics.com/api/export-data-points

This shows the structure and example data of the CSV output when exporting data from Simple Analytics. It includes fields like `added_iso`, `country_code`, `path`, and `session_id`.

```csv
added_iso,country_code,datapoint,device_type,path,session_id,utm_campaign,utm_content,utm_medium,utm_source
2025-07-03T20:13:19.100Z,US,visit_homepage,desktop,/,1e5aad53-c734-40ac-b060-426a70d1c104,ads1,,,duckduckgo
2025-07-04T18:39:04.100Z,UK,visit_homepage,desktop,/,7b03aa29-612d-4aa8-b147-72c13986c4ae,,,newsletter,
2025-07-04T18:43:04.200Z,UK,popup_show,desktop,/,7b03aa29-612d-4aa8-b147-72c13986c4ae,,,,
2025-07-04T19:21:09.100Z,NL,visit_homepage,desktop,/,928e4f2f-1f16-4900-9ad8-0a1965e689a3,,,,google
2025-07-04T19:21:29.200Z,NL,popup_show,desktop,/,928e4f2f-1f16-4900-9ad8-0a1965e689a3,,,,
2025-07-04T19:21:59.300Z,NL,popup_close,desktop,/,928e4f2f-1f16-4900-9ad8-0a1965e689a3,,,,
```

--------------------------------

### Simple Analytics Stats API: Retrieve Data for Specific Pages using 'pages' Parameter

Source: https://docs.simpleanalytics.com/api/stats

Example API call demonstrating how to retrieve analytics data for a specific page using the 'pages' query parameter. This method allows specifying a single page path to get its associated statistics.

```APIDOC
https://simpleanalytics.com/simpleanalytics.com.json?version=5&fields=histogram&pages=/contact
```

--------------------------------

### Example API Request with Date Placeholders and Time Zone

Source: https://docs.simpleanalytics.com/api/helpers

Demonstrates how to construct a Simple Analytics API request using date placeholders ('yesterday', 'today') and specifying a time zone ('UTC') to fetch histogram data for a specific period.

```APIDOC
https://simpleanalytics.com/simpleanalytics.com.json?version=5&fields=histogram&start=yesterday&end=today&timezone=UTC
```

--------------------------------

### Example HTML structure for a basic link

Source: https://docs.simpleanalytics.com/events/custom-link-clicks

This HTML snippet demonstrates a standard paragraph containing a hyperlink. It serves as the base structure before applying any custom event tracking attributes for Simple Analytics.

```HTML
<p>This is <a href="/">a link</a>.</p>
```

--------------------------------

### Add Simple Analytics Rails Gem to Gemfile

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-ruby-on-rails

To include the `simple_analytics_rails` gem in your Ruby on Rails project, add this line to your application's Gemfile. This declares the gem as a dependency for your project.

```Ruby
gem 'simple_analytics_rails'
```

--------------------------------

### Simple Analytics Server-side Event JSON Payload Example

Source: https://docs.simpleanalytics.com/events/server-side

Example JSON structure required for submitting event data to the Simple Analytics server-side endpoint. Includes mandatory fields like type, hostname, event name, and user agent.

```JSON
{
  "type": "event",
  "hostname": "example.com",
  "event": "event-name",
  "ua": "User Agent"
}

```

--------------------------------

### Example UTM-tagged URL

Source: https://docs.simpleanalytics.com/metrics

This snippet shows a sample URL with UTM parameters appended. UTM codes are bits of text added to links that help analytics tools like Simple Analytics track the source, medium, and campaign of traffic, providing insights into marketing efforts.

```text
https://example.com/landing-page?utm_source=company-x&utm_medium=newsletter&utm_campaign=march
```

--------------------------------

### Rendered Simple Analytics HTML output

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-django

This HTML snippet shows the final output after Django template tags are processed, illustrating how the Simple Analytics JavaScript tracking code and the noscript fallback image are embedded in the page.

```html
<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>example.com</title>
		<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no">
    ...
    <script type="text/javascript" src="https://cdn.simpleanalytics.io/hello.js"></script>
    ...
    </head>
    <body>
      <noscript><img src="https://api.simpleanalytics.io/hello.gif" alt="hello"></noscript>
    </body>
</html>
```

--------------------------------

### Send Simple Analytics Events with JavaScript

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-next

This JavaScript function provides a safe way to send custom events to Simple Analytics. It checks for the existence of `window.sa_event` before attempting to call it, preventing errors if the analytics script hasn't loaded or is blocked.

```javascript
export const saEvent = (eventName) => {
  if (window && window.sa_event) return window.sa_event(eventName);
};
```

--------------------------------

### Access Simple Analytics Data with jQuery using JSONP and CORS

Source: https://docs.simpleanalytics.com/api/cors-jsonp

This snippet demonstrates how to fetch data from Simple Analytics using jQuery's AJAX function, showcasing both JSONP for cross-domain requests and standard CORS. The JSONP example uses a `callback=?` parameter, while the CORS example relies on the `Access-Control-Allow-Origin` header set by the Simple Analytics server.

```JavaScript
$.ajax({
  url: "https://simpleanalytics.com/simpleanalytics.com.json?callback=?",
  dataType: "jsonp",
  success: function (data) {
    console.log(data);
  }
});
```

```JavaScript
$.ajax({
  url: "https://simpleanalytics.com/simpleanalytics.com.json",
  success: function (data) {
    console.log(data);
  }
});
```

--------------------------------

### Nuxt.js: Configure Simple Analytics Plugin in nuxt.config.js

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-vue

Shows how to include the Simple Analytics plugin in `nuxt.config.js`. The `ssr: false` option is crucial as it ensures the plugin runs only on the client-side, which is essential for client-side analytics libraries that interact with the browser DOM.

```javascript
export default {
  plugins: [{ src: "~/plugins/simple-analytics.js", ssr: false }]
};
```

--------------------------------

### Embed Simple Analytics JavaScript on GoDaddy Sites

Source: https://docs.simpleanalytics.com/install-simple-analytics-on-godaddy

This JavaScript snippet, embedded within an HTML script tag, is designed for GoDaddy websites to initialize the Simple Analytics tracking. It dynamically sets the website's hostname and the specific page path, allowing for accurate analytics collection. Users must customize the 'hostname' and 'path' variables to match their site and individual pages.

```JavaScript
<script type="text/javascript">
// Simple Analytics script for GoDaddy Sites
// Fill in your hostname and the path for every page on your GoDaddy site
// If your page is https://example.com/ then the hostname is "example.com" and the path is "/"
// If your page is https://example.com/blog then the hostname is "example.com" and the path is "/blog"
var hostname = "yoursite.godaddysites.com";
var path = "/";

// Do not change anything below this line
function goDaddyPathOverwriter() { return path; }

var script = document.createElement("script");
script.src = "https://scripts.simpleanalyticscdn.com/latest.js";
script.setAttribute("data-hostname", hostname);
script.setAttribute("data-path-overwriter", "goDaddyPathOverwriter");
document.head.appendChild(script);
</script>
```

--------------------------------

### Configure Custom Tracking Domain for Simple Analytics Docusaurus Plugin

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-docusaurus

To use a custom domain for Simple Analytics tracking, which can help bypass ad-blockers, specify the domain option within the plugin configuration in docusaurus.config.js. Replace 'custom.domain.com' with your actual custom domain.

```JavaScript
plugins: [
  ...
  ['docusaurus-plugin-simple-analytics', {
    domain: 'custom.domain.com'
  }],
  ...
],
```

--------------------------------

### Register Simple Analytics Plugin in Nuxt 2 Configuration

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-nuxt

This snippet modifies `nuxt.config.js` to register the `simple-analytics.js` plugin. By setting `ssr: false`, it ensures the plugin is only executed on the client-side, which is crucial for browser-based analytics libraries.

```javascript
// nuxt.config.js

export default {
  plugins: [{ src: "~/plugins/simple-analytics.js", ssr: false }],
};
```

--------------------------------

### Example Cleaned User-Agent String

Source: https://docs.simpleanalytics.com/metrics

This snippet shows a user-agent string after Simple Analytics has processed it. For privacy reasons, Simple Analytics replaces long numbers within the user-agent string with zeros, ensuring that specific device identifiers are not retained.

```text
Mozilla/5.0 (iPad; U; CPU OS 3_2_0) AppleWebKit/531.21.0 (KHTML, like Gecko) Mobile/7B40000
```

--------------------------------

### Vue.js: Send Custom Events with saEvent

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-vue

Demonstrates how to send custom events using the globally available `saEvent` method within a Vue.js component's methods. Events are logged to the console for debugging when not in a production environment.

```javascript
{
  methods: {
    likeComment (comment) {
      // code to like comment
      this.saEvent(`comment_like_${comment.id}`)
    }
  }
}
```

--------------------------------

### Initialize Simple Analytics in Vue.js with Conditional Skip

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-vue

This snippet demonstrates how to import and register the Simple Analytics plugin with Vue.js. It utilizes the 'skip' option to conditionally disable tracking, typically used to prevent data collection during development by checking the Node.js environment.

```JavaScript
import SimpleAnalytics from "simple-analytics-vue";
import Vue from "vue";

Vue.use(SimpleAnalytics, { skip: process.env.NODE_ENV !== "production" });
```

--------------------------------

### Simple Analytics Admin API: List Websites Endpoint

Source: https://docs.simpleanalytics.com/api/admin

Defines the HTTP GET endpoint for retrieving a list of all websites associated with a Simple Analytics user account. This is the only Admin API endpoint available for all plans and requires specific authentication headers.

```APIDOC
GET https://simpleanalytics.com/api/websites

Headers:
  Content-Type: application/json
  Api-Key: string (required, from account settings)
  User-Id: string (required, from account settings)

Returns: List of websites for the user.
```

--------------------------------

### Nuxt 3 Plugin Configuration: Skip Tracking in Development

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-nuxt

This configuration extends the basic Simple Analytics plugin for Nuxt 3 by adding an option to skip tracking when the application is running in a non-production environment. This is useful for preventing development traffic from skewing analytics data.

```javascript
import SimpleAnalytics from "simple-analytics-vue";

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.use(SimpleAnalytics, {
    skip: process.env.NODE_ENV !== "production",
  });
});
```

--------------------------------

### Add Simple Analytics Script to Next.js Pages Router

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-next

This JavaScript snippet illustrates how to integrate the Simple Analytics tracking script into a Next.js application using the Pages Router. The `Script` component from `next/script` is added to the `_app.js` file, ensuring the analytics script is loaded across all pages in the application.

```JavaScript
// pages/_app.js
import Script from 'next/script'

export default function MyApp({ Component, pageProps }) {
  return (
    <>
      <Component {...pageProps} />
      <Script src="https://scripts.simpleanalyticscdn.com/latest.js" />
    </>
  )
}
```

--------------------------------

### Collect Page Views with Pixel (Basic)

Source: https://docs.simpleanalytics.com/without-javascript

Demonstrates how to use an HTML `<img>` tag to send page view data to Simple Analytics without JavaScript. This example includes `timezone` and `unique` parameters to customize the collected information.

```HTML
<img
  src="https://queue.simpleanalyticscdn.com/noscript.gif?timezone=Europe%2FAmsterdam&unique=false"
  referrerpolicy="no-referrer-when-downgrade"
  alt=""
/>
```

--------------------------------

### Integrate Simple Analytics Script in Next.js _app.tsx

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-next

This snippet demonstrates how to add the Simple Analytics script to a Next.js application using `next/script` in `_app.tsx` for versions prior to Next.js 13. It uses the `afterInteractive` strategy for optimal loading and includes a `noscript` fallback for users with JavaScript disabled.

```tsx
import type { AppProps } from "next/app";
import React from "react";
import Script from "next/script";

function MyApp({ Component, pageProps }: AppProps) {
  return (
    <React.Fragment>
      <Component {...pageProps} />
      <Script src="https://scripts.simpleanalyticscdn.com/latest.js" />
      <noscript>
        {/* eslint-disable @next/next/no-img-element */}
        <img
          src="https://queue.simpleanalyticscdn.com/noscript.gif"
          alt=""
          referrerPolicy="no-referrer-when-downgrade"
        />
      </noscript>
    </React.Fragment>
  );
}

export default MyApp;
```

--------------------------------

### Add Simple Analytics Script to Next.js App Router

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-next

This JavaScript snippet demonstrates how to embed the Simple Analytics tracking script into a Next.js application using the App Router. The `Script` component from `next/script` is placed within the `RootLayout` component, ensuring the analytics script loads globally for all pages.

```JavaScript
// app/layout.js
import Script from 'next/script'

export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body>{children}</body>
      <Script src="https://scripts.simpleanalyticscdn.com/latest.js" />
    </html>
  )
}
```

--------------------------------

### Configure Simple Analytics with Custom Domain in Vue.js

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-vue

This snippet illustrates how to specify a custom domain for Simple Analytics tracking within your Vue.js application. Using a custom domain can help in bypassing ad blockers, ensuring more reliable data collection.

```JavaScript
Vue.use(SimpleAnalytics, { domain: "api.example.com" });
```

--------------------------------

### Define Simple Analytics Vue Plugin in Nuxt 2

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-nuxt

This JavaScript code defines a Nuxt.js plugin (`~/plugins/simple-analytics.js`) that imports and registers the `simple-analytics-vue` library with Vue. It conditionally skips analytics tracking in non-production environments, ensuring data is only sent from live deployments.

```javascript
// ~/plugins/simple-analytics.js

import SimpleAnalytics from "simple-analytics-vue";
import Vue from "vue";

Vue.use(SimpleAnalytics, { skip: process.env.NODE_ENV !== "production" });
```

--------------------------------

### Nuxt 3 Plugin Configuration: Custom Domain for Ad-Blocker Bypass

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-nuxt

This advanced configuration for the Simple Analytics Nuxt 3 plugin allows specifying a custom domain for data collection. This is primarily used to bypass ad-blockers by routing analytics requests through a domain you control, while also retaining the development skip functionality.

```javascript
import SimpleAnalytics from "simple-analytics-vue";

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.use(SimpleAnalytics, {
    skip: process.env.NODE_ENV !== "production",
    domain: "api.example.com"
  });
});
```

--------------------------------

### Send Simple Analytics Events with TypeScript

Source: https://docs.simpleanalytics.com/install-simple-analytics-with-next

This TypeScript snippet defines a type declaration for `sa_event` and provides a type-safe function to send custom events to Simple Analytics. It ensures type checking for the event name and safely calls the analytics function if available.

```typescript
declare function sa_event(eventName: string);

export const saEvent = (eventName: string) => {
  if (window && window.sa_event) return window.sa_event(eventName);
};
```

--------------------------------

### Simple Analytics API Authentication Requirements

Source: https://docs.simpleanalytics.com/api/export-data-points

This section outlines the authentication requirements for accessing the Simple Analytics API. API requests must include `Api-Key` and `User-Id` headers, which start with specific prefixes, to ensure secure access to data.

```APIDOC
Authentication Method: Header-based
Required Headers:
  Api-Key: Must start with `sa_api_key_...`
  User-Id: Must start with `sa_user_id_...`
```

--------------------------------

### Ignore a single page with Simple Analytics script

Source: https://docs.simpleanalytics.com/ignore-pages

This snippet demonstrates how to configure the Simple Analytics tracking script to ignore a single specific page by providing its path to the `data-ignore-pages` attribute. The path should start with a slash and exclude the domain name, for example, `/vouchers` for `https://example.com/vouchers`.

```HTML
<script
  data-ignore-pages="/vouchers"
  src="https://scripts.simpleanalyticscdn.com/latest.js"
></script>
```

--------------------------------

### Simple Analytics Stats API: Requesting 'seconds_on_page' Field

Source: https://docs.simpleanalytics.com/api/stats

API request example demonstrating how to include the 'seconds_on_page' field along with other fields like 'pages' to retrieve median time on page data. This field provides insights into user engagement.

```APIDOC
https://simpleanalytics.com/simpleanalytics.com.json?version=5&fields=pages,seconds_on_page&pages=/,/contact
```

--------------------------------

### HTML Meta Tag for Content-Security-Policy

Source: https://docs.simpleanalytics.com/csp

Example of configuring Content-Security-Policy (CSP) using an HTML <meta> tag. This policy allows scripts from 'self', 'unsafe-inline', and Simple Analytics CDN, connections to Simple Analytics queue, and images from 'self', Simple Analytics queue, and badges.simpleanalytics.com. The 'unsafe-inline' directive is required for automated event tracking.

```HTML
<meta http-equiv="Content-Security-Policy" content="script-src 'self' 'unsafe-inline' https://scripts.simpleanalyticscdn.com; connect-src 'self' https://queue.simpleanalyticscdn.com; img-src 'self' https://queue.simpleanalyticscdn.com https://simpleanalyticsbadges.com;">
```

--------------------------------

### Ignore multiple pages with Simple Analytics script

Source: https://docs.simpleanalytics.com/ignore-pages

This snippet shows how to ignore multiple pages from tracking by providing a comma-separated list of page paths to the `data-ignore-pages` attribute. Each path must start with a slash and represent the part of the URL after the domain name, such as `/search/contact,/accounts/@adriaan,/vouchers`.

```HTML
<script
  data-ignore-pages="/search/contact,/accounts/@adriaan,/vouchers"
  src="https://scripts.simpleanalyticscdn.com/latest.js"
></script>
```

--------------------------------

### Configure Simple Analytics Script with data-hostname

Source: https://docs.simpleanalytics.com/overwrite-domain-name

This snippet demonstrates how to include the Simple Analytics script and use the `data-hostname` attribute to specify a custom domain name for data collection. The first example shows an empty hostname, while the second shows a specific domain, 'example.com'. This is crucial for consolidating data from various sources under a unified view in the Simple Analytics dashboard.

```HTML
<script async data-hostname="" src="https://scripts.simpleanalyticscdn.com/latest.js"></script>
```

```HTML
<script async data-hostname="example.com" src="https://scripts.simpleanalyticscdn.com/latest.js"></script>
```

--------------------------------

### Send Page View Data via cURL

Source: https://docs.simpleanalytics.com/events/server-side

Illustrates a cURL command for submitting page view data to the Simple Analytics events endpoint. This example shows the JSON payload structure for a page view, including type, hostname, event, path, and user agent.

```shell
curl -X POST -H "Content-Type: application/json" -d '{
  "type": "pageview",
  "hostname": "mobile-app.example.com",
  "event": "pageview",
  "path": "/my-page-name",
  "ua": "Your User Agent"
}' https://queue.simpleanalyticscdn.com/events
```

--------------------------------

### Export Daily Data from Simple Analytics API (cURL)

Source: https://docs.simpleanalytics.com/api/export-data-points

This cURL example demonstrates how to export daily pageview data from the Simple Analytics API. It includes parameters for date range, robot filtering, timezone, and specific fields, along with required authentication headers. This snippet is useful for testing API key functionality.

```Shell
curl "https://simpleanalytics.com/api/export/datapoints?version=5&format=csv&hostname=simpleanalytics.com&start=2025-06-04&end=2025-07-04&robots=false&timezone=Europe%2FAmsterdam&fields=added_iso,path&type=pageviews" \
     -H 'User-Id: sa_user_id_00000000-0000-0000-0000-000000000000' \
     -H 'Api-Key: sa_api_key_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
     -H 'Content-Type: text/csv'
```

--------------------------------

### Authenticate Simple Analytics API for User Data using API Key and User ID (cURL)

Source: https://docs.simpleanalytics.com/api/authenticate

This cURL example illustrates how to authenticate API requests that require both an `Api-Key` and a `User-Id`. The `User-Id` header is necessary for accessing user-specific data, such as a list of websites associated with the account. Both credentials can be found in your Simple Analytics account settings.

```Shell
curl "https://simpleanalytics.com/api/websites" \
     -H 'Content-Type: application/json' \
     -H 'Api-Key: sa_api_key_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
     -H 'User-Id: sa_user_id_00000000-0000-0000-0000-000000000000'
```
Tokens:
Raw