Giter VIP home page Giter VIP logo

gatsby-plugin-google-analytics-reporter's Introduction

gatsby-plugin-google-analytics-reporter

Queries page views data from google analytics.

How to use

Install the package.

$ npm i gatsby-plugin-google-analytics-reporter

Add it to gatsby-config.js, make sure you have set up the variables needed to query analytics (guide here)

// gatsby-config.js
{
  resolve: `gatsby-plugin-google-analytics-reporter`,
  options: {
    email: process.env.CLIENT_EMAIL,
    privateKey: process.env.PRIVATE_KEY,
    viewId: process.env.VIEWID,
    startDate: `30daysAgo`,
    endDate: `today`,
    pageSize: 10000
  }
},

The plugin accept an object following the schema below.

Prop Required Type Description
clientEmail true string The service account email enabled on Google Could to query the analytics service.
privateKey true string The private key from the service account provided above.
viewId true string Google analytics viewId for the project to query. It can be found on google analytics > Admin (cog icon) > View settings
startDate false string The start and end dates are specified in ISO8601 date format YYYY-MM-DD, ex: 2010-04-28. Everything accepted by Google Reporting API, like 30daysAgo, today and yesterday is also a valid input. Defaults to 2008-01-01.
endDate false string The start and end dates are specified in ISO8601 date format YYYY-MM-DD, ex: 2010-04-28. Everything accepted by Google Reporting API, like 30daysAgo, today and yesterday is also a valid input. Defaults to today.
pageSize false number Maximum number of results to return. For Google Reporting API v4 this can not exceed 100000. Defaults to 1000.

Once implemented, you can check that the query work on localhost:8000/__graphql. There you will find two new keys available for queries: pageViews and allPageViews.

Examples for both queries:

// graphql
query MyQuery {
  allPageViews(sort: {order: DESC, fields: totalCount}) {
    nodes {
      id
      totalCount
    }
  }
}

// returns
{
  "data": {
    "allPageViews": {
      "nodes": [
        {
          "id": "/",
          "totalCount": 703
        },
        {
          "id": "/how-to-set-up-gatsby-typescript-eslint-prettier/",
          "totalCount": 126
        },
        {
          "id": "/react-hooks-vs-redux/",
          "totalCount": 121
        },
      ],
    },
  },
}
// graphql
query MyQuery {
  pageViews(id: {eq: "/how-to-set-up-gatsby-typescript-eslint-prettier/"}) {
    id
    totalCount
  }
}

// returns
{
  "data": {
    "pageViews": {
      "id": "/how-to-set-up-gatsby-typescript-eslint-prettier/",
      "totalCount": 126
    }
  }
}

gatsby-plugin-google-analytics-reporter's People

Contributors

kornil avatar vacilando avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.