https://github.com/toddself/ga-collect

analytics.js library for node
https://github.com/toddself/ga-collect

Last synced: about 1 year ago
JSON representation

analytics.js library for node

• Host: GitHub
• URL: https://github.com/toddself/ga-collect
• Owner: toddself
• License: mit
• Created: 2013-11-13T20:25:54.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2013-11-13T21:02:15.000Z (over 12 years ago)
• Last Synced: 2025-04-26T12:22:20.212Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 125 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![build status](https://secure.travis-ci.org/toddself/ga-collect.png)](http://travis-ci.org/toddself/ga-collect)

#ga-collect

A backend interface for the new version of Google Analytics, analytics.js, allowing you to proxy your events from your server rather than load the analytics code directly into the browser.

##Installation

`npm install ga-collect`

##Usage

```javascript

var GA = require('ga-collect');

var ga = new GA({urchin: 'UA-XXXXX-X'});

ga.pageview(

  {

    location: 'http://foobar.baz/a?b#c',

    hostname: 'foobar.baz',

    page: '/a',

    title: 'Baz the Foo in the Bar!'

  }, function(err){

    if(err){

      console.log(err);

    }

  });

```

##Methods

The keys for the event object passed into each function are the `Field Name` parameters from the [Analytics.js Field Reference](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference).

The following methods are supported, the callback is entirely optional. No success or failure message will be passed to it unless the server responds with a non 2XX status code:

`#pageview(event, cb)`

`#appview(event, cb)`

`#event(event, cb)`

`#transaction(event, cb)`

`#item(event, cb)`

`#social(event, cb)`

**Note:** Social events *MUST* contain all three [social interaction](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#socialNetwork) parameters. If they are not provided, an error will be thrown.

`#exception(event, cb)`

`#timing(event, cb)`

##Development

```bash

git clone https://github.com/toddself/ga-collect

cd ga-collect

npm install

```

##License & Copyright

Copyright (c) 2013 Todd Kennedy, licensed under the [MIT License](/LICENSE)