# simple-google-analytics

> A simple to use NodeJs package for the Google Analytics Reporting API

Latest version **0.2.7** (published 2018-07-19) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install simple-google-analytics
pnpm add simple-google-analytics
yarn add simple-google-analytics
bun add simple-google-analytics
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.2.7 |
| Published | 2018-07-19 |
| First published | 2018-07-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 34.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Ringolds Lescinskis |
| Maintainers | ringoldslescinskis |
| Keywords | nodejs, google analytics, ga, analytics api, google analytics api, analytics reporting api v4, universal analytics, analytics v4, reporting api v4, google analytics client |

## Links

- npm: https://www.npmjs.com/package/simple-google-analytics
- Repository: https://github.com/lescinskiscom/node-simple-ga
- Homepage: https://github.com/lescinskiscom/node-simple-ga#readme
- Issues: https://github.com/lescinskiscom/node-simple-ga/issues
- npm.io page: https://npm.io/package/simple-google-analytics

## Dependencies (3)

- [moment](https://npm.io/package/moment.md) ^2.22.2
- [clone-deep](https://npm.io/package/clone-deep.md) ^4.0.0
- [googleapis](https://npm.io/package/googleapis.md) ^32.0.0

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 0.2.7 (latest) — 2018-07-19
- 0.2.4 — 2018-07-13
- 0.2.3 — 2018-07-13
- 0.2.2 — 2018-07-13
- 0.2.1 — 2018-07-12
- 0.2.0 — 2018-07-12

## README

# Warning

This package was renamed to [**node-simple-ga**](https://www.npmjs.com/package/node-simple-ga). Please use that one.

# Simple Google Analytics client for NodeJs
A simple to use NodeJs package for the Google Analytics Reporting API.
This is still very much work in progress so please check back.

## Down to business
It should be much easier to retrieve data from the Google Analytics API and this package helps you achieve that. Focus on analyzing the data let it handle the rest.

Getting the top 10 links is as simple as this:

```JavaScript
var analytics = new SimpleGA("./key.json");

var request = (new Request())
	.view(12345678)
	.results(10)
	.dimension("pagePath")
	.metric("pageviews")
	.orderDesc("pageviews");
	
var data = await analytics.run(request);
```	

By default, data will be returned as an array of objects in the format below. For the top 10 list the result would look similar to this:

```JavaScript
[
	{
		dimensions: {
			pagePath: "/"
		},
		metrics: {
			pageviews: 123
		}
	},
	...
]
```
It's that simple!
## What it really is
**node-simple-ga** helps you create and make [Reporting API v4 compliant](https://developers.google.com/analytics/devguides/reporting/core/v4/rest/v4/reports/batchGet) JSON requests in a function-oriented manner, parse the response, and paginate additional requests if requested by the user. Further improvements will be focused on creating requests in a more robust and efficient way.
## What it won't be
This package is not and will not be a data processing package. Data processing is left up to you - the developer.
## Installation
To use the package, run:
```JavaScript
npm i node-simple-ga
```
Before using the package, you must create and set up a [Service Account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount). You can also watch a video tutorial on [how to set up a Service account](https://www.youtube.com/watch?v=r6cWB0xnOwE). While the title says it's a PHP tutorial, it doesn't really matter because you won't be using PHP anyway. Focus on the account creation and granting read access to the service account.
## Usage
Typical usage for the script follows the following script:
1) Require node-simple-ga
2) Initialize the analytics package by providing a valid service account key (see Installation)
3) Create a request object
4) Add criteria to the request object
5) Create dimension and metric filters
6) Add filters to the request
7) Run the request

Optionally:
1) Clone the request object
2) Make changes to the request object
3) Run the request

## Example #1
**Task**
* Return all pages of two views XXXXXXXX and YYYYYYYY who don't have at least 100 pageviews,
* Show page urls, pageviews and metrics,
* Make sure page url doesn't contain /archive/,
* Load only those entries that came from the US,
* Sort results by the amount of users in a descending order

```JavaScript
const {
	SimpleGA,
	Request,
	MetricFilter,
	DimensionFilter
} = require("node-simple-ga");

(async function() {
	var analytics = new SimpleGA("./key.json");

	var request1 = (new Request())
		.view(XXXXXXXX)
		.results(10)
		.dimension("pagePath")
		.metrics(["pageviews","users"])
		.orderDesc("users");

	var pagePathFilter = (new DimensionFilter())
		.dimension("pagePath")
		.contains("/archive/")
		.not();
	
	var countryFilter = (new DimensionFilter())
		.dimension("country")
		.matches("US");

	request.dimensionFilters(pagePathFilter,countryFilter);

	var pageviewsFilter = (new MetricFilter())
		.metric("pageviews")
		.lessThanEqualTo(100);

	request.metricFilter(pageviewsFilter);

	var request2 = request1.clone().view(YYYYYYYY);

	try {
		var {data1, data2} = await Promise.all([
			analytics.run(request1),
			analytics.run(request2)
		]);
	} catch (err) {
		console.error(err);
	}
})();
```
Since it's not possible to use negative lookups in Google Analytics (e.g. urls that don't contain something), you must first look up all urls with the thing you want to avoid and then negate the operation (in this case with .not(), but it's also possible with .inverse())

Please note that if you don't specify a date, only the last 7 days, excluding today, will be processed.

> If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day).
> [Source](https://developers.google.com/analytics/devguides/reporting/core/v4/rest/v4/reports/batchGet#ReportRequest.FIELDS)

## Reference

## Author
Ringolds Leščinskis

Website: [www.lescinskis.com](https://www.lescinskis.com)

E-mail: ringolds@lescinskis.com

---
_Source: https://npm.io/package/simple-google-analytics · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._