1. module piwik
   1. function piwik.api (vars, callback)
   2. function piwik.loadSpammers (callback)
   3. function piwik.setup (baseURL, token, timeout)
   4. function piwik.track (vars, callback)
   5. object piwik.settings

module piwik

function piwik.api (vars, callback)

• description and source-code

  function methodApi(vars, callback) {
    vars = typeof vars === 'object' ? vars : {};
    vars.module = 'API';
    vars.format = 'JSON';
    vars.token_auth = app.settings.token;
  
    talk ({
      method: 'GET',
      path: 'index.php',
      query: vars,
      callback: callback || null
    });
  
    return app;
  }

• example usage

  n/a

function piwik.loadSpammers (callback)

• description and source-code

  function methodLoadSpammers(callback) {
    var options = {
      timeout: app.settings.timeout
    };
  
    http.get (
      'https://github.com/piwik/referrer-spam-blacklist/raw/master/spammers.txt',
      options,
      function (err, res) {
        var data;
  
        if (err) {
          callback (err);
        } else {
          data = res.body
            .trim()
            .replace (/\s+\n/g, '\n')
            .split ('\n')
            .sort();
  
          callback (null, data);
        }
      }
    );
  
    return app;
  }

• example usage

  n/a

function piwik.setup (baseURL, token, timeout)

• description and source-code

  function methodSetup(baseURL, token, timeout) {
    var url = urltool.parse (baseURL, true);
  
    app.settings.baseURL = url.protocol + '//' + url.host
      + url.pathname.replace (/\/[^\/]+$/, '/');
  
    // token in baseURL?
    app.settings.token = url.query && url.query.token_auth || null;
  
    // override with custom token, and set timeout
    if (typeof token === 'number') {
      timeout = token;
    } else if (token) {
      app.settings.token = token;
    }
  
    app.settings.timeout = timeout || app.settings.timeout;
    return app;
  }

• example usage

  n/a

function piwik.track (vars, callback)

• description and source-code

  function methodTrack(vars, callback) {
    var bulk = {
      requests: []
    };
    var i;
  
    if (app.settings.token) {
      bulk.token_auth = app.settings.token;
    }
  
    if (vars instanceof Array && vars[0] instanceof Object) {
      // array with objects
      for (i = 0; i < vars.length; i++) {
        bulk.requests.push (trackObject2request (vars[i]));
      }
    } else if (vars instanceof Object) {
      // object
      bulk.requests.push (trackObject2request (vars));
    }
  
    talk ({
      method: 'POST',
      path: 'piwik.php',
      body: JSON.stringify (bulk),
      callback: function (err, data) {
        if (err && callback) {
          callback (err);
          return;
        }
  
        if (data.status === 'success' && callback) {
          callback (null, data);
        } else if (callback) {
          callbackError ('track failed', data, null, callback);
        }
      }
    });
  
    return app;
  }

• example usage

  n/a