# @blackbox-vision/gatsby-source-google-analytics-api-most-read-posts

> Pull your most read posts from google analytics

Latest version **1.0.1** (published 2020-04-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @blackbox-vision/gatsby-source-google-analytics-api-most-read-posts
pnpm add @blackbox-vision/gatsby-source-google-analytics-api-most-read-posts
yarn add @blackbox-vision/gatsby-source-google-analytics-api-most-read-posts
bun add @blackbox-vision/gatsby-source-google-analytics-api-most-read-posts
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-04-16 |
| First published | 2020-04-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Jonatan E. Salas |
| Maintainers | jonatansalas, manutuero |
| Keywords | gatsby, gatsby-plugin, gatsby-source-plugin, gatsby-source-google-analytics-api-most-read-posts, google-analytics |

## Links

- npm: https://www.npmjs.com/package/@blackbox-vision/gatsby-source-google-analytics-api-most-read-posts
- Repository: https://github.com/BlackBoxVision/gatsby-source-analytics-most-read-posts
- Homepage: https://github.com/BlackBoxVision/gatsby-source-analytics-most-read-posts#readme
- Issues: https://github.com/BlackBoxVision/gatsby-source-analytics-most-read-posts/issues
- npm.io page: https://npm.io/package/@blackbox-vision/gatsby-source-google-analytics-api-most-read-posts

## Dependencies (1)

- [googleapis](https://npm.io/package/googleapis.md) ^48.0.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2020-04-16
- 1.0.0 — 2020-04-16

## README

# Gatsby Source for Most Read Posts from Google Analytics [![npm version](https://badge.fury.io/js/%40blackbox-vision%2Fgatsby-source-google-analytics-api-most-read-posts.svg)](https://badge.fury.io/js/%40blackbox-vision%2Fgatsby-source-google-analytics-api-most-read-posts) [![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT) [![Known Vulnerabilities](https://snyk.io/test/github/blackboxvision/gatsby-source-analytics-most-read-posts/badge.svg)](https://snyk.io/test/github/blackboxvision/gatsby-source-analytics-most-read-posts)

Get your most read Posts from Google Analytics Reporting API.

## Install

You can install this library via NPM or YARN.

### NPM

```bash
npm i @blackbox-vision/gatsby-source-google-analytics-api-most-read-posts
```

### YARN

```bash
yarn add @blackbox-vision/gatsby-source-google-analytics-api-most-read-posts
```

## Config

In your `gatsby-config.js`:

```javascript
{
    resolve: `@blackbox-vision/gatsby-source-google-analytics-api-most-read-posts`,
    options: {
        viewId: `115350264`,
        email: `example@domain.com`,
        secretKey: `yourSecretAPIKey`,
        maxResults: 10,
        filters: 'ga:pagePath!@/tag/;ga:pagePath!@/page/;ga:pagePath!=/;ga:pageTitle!=(not set);ga:pagePath!@&',
        dates: {
            from: 'today',
            to: '2019-01-01'
        }
    }
}
```

## Supported Options

| Properties | Types  | Default Value | Description                                                      |
| ---------- | ------ | ------------- | ---------------------------------------------------------------- |
| viewId     | string | none          | Your viewId for your Google Analytics property.                  |
| email      | string | none          | The email generated from the Google API Console.                 |
| secretKey  | string | none          | The PEM certificate generated from the Google API Console.       |
| maxResults | number | 3             | Total results to get from the source.                            |
| filters    | string | ''            | Filters for data from Google Analytics.                          |
| dates.from | string | 'today'       | A date formatted string or an string representing time relation. |
| dates.to   | string | '2019-01-01'  | A date formatted string or an string representing time relation. |

## Example Usage

```javascript
import React from 'react';
import { StaticQuery, graphql } from 'gatsby';

const gplQuery = graphql`
  query GetAllMostReadPosts {
    allMostReadPosts {
      nodes {
        totalViews
        title
        url
      }
    }
  }
`;

export const MostReadPosts = () => (
  <StaticQuery
    query={gplQuery}
    render={({ allMostReadPosts: { nodes: posts } }) =>
      posts.map((post, idx) => (
        <div key={idx}>
          <a href={post.url}>
            <h2>{post.title}</h2>
          </a>
        </div>
      ))
    }
  />
);

MostReadPosts.displayName = 'MostReadPosts';
```

## Issues

Please, open an [issue](https://github.com/BlackBoxVision/gatsby-source-analytics-most-read-posts/issues) following one of the issues templates. We will do our best to fix them.

## Contributing

If you want to contribute to this project see [contributing](https://github.com/BlackBoxVision/gatsby-source-analytics-most-read-posts/blob/master/CONTRIBUTING.md) for more information.

## License

Distributed under the **MIT license**. See [LICENSE](https://github.com/BlackBoxVision/gatsby-source-analytics-most-read-posts/blob/master/LICENSE) for more information.

---
_Source: https://npm.io/package/@blackbox-vision/gatsby-source-google-analytics-api-most-read-posts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._