npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@botonic/plugin-google-analytics

v0.30.0

Published

## What Does This Plugin Do?

Downloads

143

Readme

Botonic Plugin Google Analytics

What Does This Plugin Do?

With this plugin you can track the user interaction with the bot or the bot's behaviour sending the information to Google Analytics.

Setup

  1. Run npm install --save @botonic/plugin-google-analytics to install the plugin.
  2. Add it to the src/plugins.js file:

src/plugins.js

export const plugins = [
  {
    id: 'googleAnalytics',
    resolve: require('@botonic/plugin-google-analytics'),
    options: {
      measurementId: 'G-XXXXXXXXXX', // Your Google Analytics measurement ID
      apiSecret: 'xxxxxxxxxx', // Your API Secret key for the property to send events to #pragma: allowlist secret
      getUserId: ({ session }) => session.user.extra_data.clientId, // Optional. Method that returns a unique user ID as string (to track logged users for example)
    },
  },
]

You can see a detailed explanation of measurementId and apiSecret config fields here.
If no getUserId is set, the plugin will not identify the userId (logged user) to Google Analytics. The clientId will be sent either way in all trackings. (see clientId vs. userId for more information).

Usage

If the tracking is done inside the botonicInit method, make sure to call it with the await keyword to ensure its execution.
For every tracking, the user will be identified with the clientId and userId defined in the plugin's options or with its default values.

In each track call, multiple events can be sent at once (as an array) or just one at a time (as object). In any case, each event will contain the name of the event (required) and a dictionary of params (optional) with all the extra parameters to be tracked.

static async botonicInit({ input, session, params, lastRoutePath, plugins }) {
    const ga = plugins.googleAnalytics

    const event = {
      name: 'rating',
      params: {
        type: 'agent',
        value: 4,
      },
    }

    await ga.track({ session, event })
}