Example on how to run Google Analytics PageView task for each API request

Author: skitsanos

index.js

@@ -8,4 +8,22 @@ sessions.allowedResources = [
     /\/users(\/.*)?/gi
 ];
 
-sessions.init();
+sessions.init();
+
+/**
+ * Run Google Analytics on each API endpoint request
+ */
+module.context.use((req, res, next) =>
+{
+    const {runTask} = module.context;
+    runTask(
+        'Google Analytics PageView recording',
+        'ga',
+        {
+            clientId: req.headers['x-bb-client-request-uuid'],
+            path: req.path,
+            headers: req.headers
+        });
+
+    next();
+});

manifest.json

@@ -21,7 +21,11 @@
       "type": "integer",
       "description": "The time in seconds since the last update until a session will be considered expired"
     },
-
+    "googleAnalyticsId": {
+      "default": "G-Y32FMJEM1W",
+      "type": "string",
+      "description": "Google Analytics Measurement ID"
+    },
     "telegramToken": {
       "default": "xyz",
       "type": "string",

tasks/ga.js

@@ -0,0 +1,61 @@
+/**
+ * Google Analytics Measuring Task
+ * @version 1.0
+ * @author skitsanos
+ */
+
+const request = require('@arangodb/request');
+const crypto = require('@arangodb/crypto');
+
+/**
+ *
+ * @param clientId
+ * @param path
+ * @param headers
+ * @param mount
+ * @returns {boolean}
+ */
+const task = ({clientId, path, headers, context}) =>
+{
+    const {googleAnalyticsId} = context.configuration;
+
+    if (Boolean(googleAnalyticsId))
+    {
+        //https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
+
+        const params = {
+            v: '1',
+            an: 'Foxx Microservices',
+            aid: 'com.skitsanos.apps.foxx-builder',
+            tid: googleAnalyticsId, //The measurement ID / web property ID
+            cid: clientId || crypto.uuidv4(),
+            t: 'pageview',
+            ni: 1,
+            dp: `${context.mount}${path}`,
+            dt: `${context.mount}${path}`, //document title
+            ds: 'api', //data source
+            cm: 'organic',
+            de: 'UTF-8', //document encoding
+            ua: headers['user-agent'],
+            uip: headers['client-ip'] || headers['remoteAddress']
+        };
+
+        if (headers['x-country'])
+        {
+            params.geoid = headers['x-country'];
+        }
+
+        console.log(params);
+        request({
+            method: 'get',
+            url: 'https://www.google-analytics.com/collect',
+            qs: params
+        });
+
+        return true;
+    }
+
+    return false;
+};
+
+module.exports = task;