gatoo

0.1.170 • Public • Published

logomakr_32f2md

Build Status codecov npm GitHub license Maintenance Donate

this project will provide a command line and a library to export google analytics to your prefered endpoint (console, log management, or db).

Use as Command Line

install globally with npm install gatoo -g. Aftyer this it can be run with the next command:

gatoo console <email> <ReplativePath> <viewId> <startDate> <endDate> <metrics> <dimensions>

Use as library

first step is to add this to your project throught yarn add gatoo or npm install gatoo

currently you can retrieve in a simple way data from google analytics and route it to your prefered output. An example of retrieval is the next one.

Import

const importer = require('../lib/index').importer
    path = require('path')
    
const email = 'your email' //email account from the user credentials
    keyPath = path.join(__dirname, 'your credentials')// path to credentials json or pem
    config = {
    viewId: "some viewId",//the view id to query
    daterange:{
        "endDate":"2017-06-30",
        "startDate":"2016-06-30"
      },
      metrics: "ga:users",
      dimensions: "ga:date"
    }

const example = async () => {
    const result = await importer(email, keyPath, config)
    console.log(JSON.stringify(result.data))
}

example()

Export

const exporter = require('../lib/index').exporter
    path = require('path')
    
const email = 'your email' //email account from the user credentials
    keyPath = path.join(__dirname, 'your credentials')// path to credentials json or pem
    config = {
    viewId: "some viewId",//the view id to query
    daterange:{
        "endDate":"2017-06-30",
        "startDate":"2016-06-30"
      },
      metrics: "ga:users",
      dimensions: "ga:date"
    }

const doSomething () => {}

const example = async () => {
    const result = await exporter(email, keyPath, config,  doSomething)
}

example()

Export to console

const exporter = require('../lib/index').outputTo
    path = require('path')
    
const email = 'your email' //email account from the user credentials
    keyPath = path.join(__dirname, 'your credentials')// path to credentials json or pem
    config = {
    viewId: "some viewId",//the view id to query
    daterange:{
        "endDate":"2017-06-30",
        "startDate":"2016-06-30"
      },
      metrics: "ga:users",
      dimensions: "ga:date"
    }

const example = async () => {
    const result = await outputTo.console(email, keyPath, config)
}

example()

TODO

  • [x] Retrieve data from google analytics
  • [x] Create library
  • [x] Create adapter for output console
  • [x] Create command line tool console
  • [ ] Create adapter logstash
  • [ ] Create adapter fluentd
  • [ ] Create adapter ES
  • [ ] Create command line tool logstash
  • [ ] Create command line tool fluentd
  • [ ] Create command line tool ES

Logo

Check out the new logo that I created on LogoMakr.com https://logomakr.com/32f2Md

Package Sidebar

Install

npm i gatoo

Weekly Downloads

2

Version

0.1.170

License

MIT

Unpacked Size

23.8 kB

Total Files

23

Last publish

Collaborators

  • kanekotic