Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blackboxvision/gatsby-source-analytics-most-read-posts
:rocket: Get your most read Posts from Google Analytics Reporting API.
https://github.com/blackboxvision/gatsby-source-analytics-most-read-posts
gatsby gatsby-plugin library nodejs react
Last synced: about 1 month ago
JSON representation
:rocket: Get your most read Posts from Google Analytics Reporting API.
- Host: GitHub
- URL: https://github.com/blackboxvision/gatsby-source-analytics-most-read-posts
- Owner: BlackBoxVision
- License: mit
- Created: 2020-04-16T00:40:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T18:04:32.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T05:01:51.189Z (about 1 month ago)
- Topics: gatsby, gatsby-plugin, library, nodejs, react
- Language: JavaScript
- Homepage:
- Size: 213 KB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gatsby Source for Most Read Posts from Google Analytics [](https://badge.fury.io/js/%40blackbox-vision%2Fgatsby-source-google-analytics-api-most-read-posts) [](https://opensource.org/licenses/MIT) [](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: `[email protected]`,
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 = () => (
posts.map((post, idx) => (
))
}
/>
);
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.