Jump to content
Wanze

ProcessGoogleAnalytics

Recommended Posts

Hi!
Just finished my first module :)
This module adds a new "Google-Analytics" Page in your Admin-Panel and displays various Statistics from a Google Analytics Account.
It uses the JQuery plugin "jqplot" to display the charts.

post-582-0-13454000-1344773004_thumb.pngpost-582-0-53154400-1344773005_thumb.pngpost-582-0-49753600-1344773006_thumb.png

Github: https://github.com/w...GoogleAnalytics
Modules directory: http://modules.proce...ogle-analytics/

Features

  • Visits by Date (Chart)
  • General Statistics about Visits (Total visits, Visit duration, New visitors, Returning visitors etc.)
  • Demographics: Countries, Cities, Languages
  • System: Browsers, Operating Systems, Screen Resolutions
  • Mobile: Operating Systems, Screen Resolutions
  • Pageviews by Date (Chart)
  • Top Content
  • Traffic Sources: Keywords, Referral Traffic by Domain and URI
  • Choose a default date range displaying statistics: last 24 hours, 2 days, 1 week, 1 month etc.
  • Custom date range by setting a "start date" and "end date"

Requirements

  • Google Account and Analytics Account :P
  • A Project in the Google APIs Console
  • cURL

Installation

1) Create a Project in the Google APIs Console:

  • Create a new Project in the APIs Console: code.google.com/apis/console/
  • Under Services, enable the Analytics API
  • Under API Access: create an Oauth 2.0 Client-ID
  • Give a Product Name, choose "Web-Application", Domain doesn't matter
  • Enter a Redirect URI to the GA-Page in your Processwire Installation:
    http://yourdomain.com/processwire/google-analytics/

Notes:

  • The redirect URI must exactly match with the URL from the new "Google Analytics" page in Processwire. Open the Page and copy the URL from the address-bar (localhost does work too!)
  • The project created in the APIs Console can be reused for every Processwire installation using this module. You just have to enter more redirect URIs

2) Install the module:

  • Place the module's files in /site/modules/ProcessGoogleAnalytics
  • Install the Module via the Admin-Panel
  • Enter Client-ID and Client-Secret keys from the created project in the module config
  • Load the newly created page "Google-Analytics" and click on the button "authenticate"
  • Grant the module access to the Analytics Data
  • Choose a Google Analytics account (Domain) from the dropdown
  • Done: You should see the statistics. Check out the module config options for further customization

In order to let other users see the Google Analytics page, you must give their role access to the "ga-view" permission.

Ps. Processwire is awesome and so is this community! :)

  • Like 29
  • Thanks 1

Share this post


Link to post
Share on other sites

Awesome! I also wanted to do something similar but didn't really get into it. Looks very nice! Thanks for posting.

Would you mind to put it on modules.processwire.com and create a repository on github?

Share this post


Link to post
Share on other sites

Whoa! Looks amazing and very useful module. Will definitely try this soon!

Share this post


Link to post
Share on other sites

I just drooled on my keyboard.

I'll be installing this one on my sites definitely!

Share this post


Link to post
Share on other sites

Thank you guys!

In the meanwhile, the Project is on Github and the modules overview:

http://modules.processwire.com/modules/process-google-analytics/

https://github.com/wanze/ProcessGoogleAnalytics

I never used Github before and had to create an account first, thanks Soma for your Tutorial!

Still I'll have to explore git a bit more ;-)

Please let me know what you think and if it works for you!

One feature that is on the Roadmap:

Compare the statistics taken from the last month (Audience) with the previous month and show +/- percentage

  • Like 3

Share this post


Link to post
Share on other sites

Wanze, welcome to the forums!

Great start! I tried your module on my localhost and it seems to work, though I don't have any statistics here.

When I load the Google Analytics page for the first time I get several notices:

Notice: Undefined index: ga:returningVisits in D:\webdev\xampp\htdocs\P21\site\modules\ProcessGoogleAnalytics\ProcessGoogleAnalytics.module on line 227
Notice: Undefined index: rows in D:\webdev\xampp\htdocs\P21\site\modules\ProcessGoogleAnalytics\ProcessGoogleAnalytics.module on line 298
Notice: Undefined index: rows in D:\webdev\xampp\htdocs\P21\site\modules\ProcessGoogleAnalytics\ProcessGoogleAnalytics.module on line 299

But they dissapear after I refresh the page, so I guess it has something to do with caching.

Also after installation I get this notice untill I've filled all fields and saved:

Notice: Undefined index: accountId in D:\webdev\xampp\htdocs\P21\site\modules\ProcessGoogleAnalytics\ProcessGoogleAnalytics.module on line 877

And also for some reason it breaks page encoding (cyrillic symbols don't display properly).

Wanted to mention you can specify what modules are required by your module and what modules it installs in the array returned by getModuleInfo():

return array(
'title' => '',
'version' => 001,
'summary' => '',
'requires' => 'MarkupCache',
'installs' => 'MarkupCache', //not sure about this one
);

Not sure though whether it should require or instead maybe install MarkupCache, I guess it shoud just require it. See more here.

Thank you for your module! I've never dealt with GA before, and I guess now's the time :)

  • Like 1

Share this post


Link to post
Share on other sites

This is great! Really cool stuff going around lately!

Share this post


Link to post
Share on other sites

Just installed this one and it works like a charm! Really nice and very polished work. Very nice that it is already multilang friendly!

Few ideas for further development:

  • There are quite a lot stuff on screen. It might be nicer UI if you would use tabs instead of folding for main categories (audience, content, traffic sources)
  • Showing current month is what I usually want, but it would be nice to have ability to choose date range
  • Link to Google Analytics when you want to dive deeper into the analytics
  • Consider using strftime instead of date - that would allow local month names etc for other languages than English. Not necessary though, since one could always define numeric only dates (like 9.8.2012) http://www.php.net/manual/en/function.strftime.ph
  • Like 3

Share this post


Link to post
Share on other sites

It's "swiss made" quality! ;)

  • Like 4

Share this post


Link to post
Share on other sites

Awesome module and really nicely produced! Thanks for making this.

I ran into a couple really minor things, but figured I'd mention them before I forget. :)

1. Saw a couple PHP notices at the top of the screen, but can't remember exactly at what part. However, I'm guessing anyone with debug mode on will see the same.

2. Getting an overflow on the search keywords screen:

post-2-0-05364600-1344521418_thumb.png

Great job with the module and the code.

  • Like 1

Share this post


Link to post
Share on other sites

Thank you all for testing and the feedback!

I'll fix the PHP warnings with the notices, maybe this will also sort out the

problem with cyrillic symbols.

2. Getting an overflow on the search keywords screen:

post-2-0-05364600-1344521418_thumb.png

Ryan, I guess this is caused by a long keyword without spaces?

Just installed this one and it works like a charm! Really nice and very polished work. Very nice that it is already multilang friendly!

Few ideas for further development:

  • There are quite a lot stuff on screen. It might be nicer UI if you would use tabs instead of folding for main categories (audience, content, traffic sources)
  • Showing current month is what I usually want, but it would be nice to have ability to choose date range
  • Link to Google Analytics when you want to dive deeper into the analytics
  • Consider using strftime instead of date - that would allow local month names etc for other languages than English. Not necessary though, since one could always define numeric only dates (like 9.8.2012) http://www.php.net/m...ion.strftime.ph

Great ideas!

Trying to implement all of this in the next versions.

I originally also wanted to use Tabs for the main sections, but I think

the charts have some problems rendering correctly if they're in a hidden div,

so I went with this simpler solution. But you're right, there is definitely too much on the screen right now!

Now it's time to find some examples using WireTabs :)

Share this post


Link to post
Share on other sites

Great! WireTabs are super simple and work just like those other wrappers. Also simpler solution might be to just collapse others than first section.

Share this post


Link to post
Share on other sites

It's also just fine to use jQuery UI tabs if you prefer. WireTabs are mainly useful for tabbing PW's Inputfields, which jQuery UI tabs don't let themselves as well to.

Share this post


Link to post
Share on other sites

Just updated the Module to version 1.1 on Github and Modules Section of Pw!

New Features / Optimizations

  • Better UI with tabs for the main categories (Audience, Content, Traffic sources)
  • New options section: You can change the date range for your Statistics
  • "strftime" used instead of "date" for the date range in header
  • Fixed PHP notice errors

There changed some module default config options + I added an option to set the format for the InputfieldDatetime fields. So I guess you should uninstall and install the whole module again to avoid errors.

Sometimes I'm not sure if use the right words for my lables and descriptions, as I'm not a native english speaker/writer.

So if anybody sees typo errors or a description that makes no sense, please tell me.

It's also just fine to use jQuery UI tabs if you prefer. WireTabs are mainly useful for tabbing PW's Inputfields, which jQuery UI tabs don't let themselves as well to.

I ended up using WireTabs, amazing simple to implement as everything with Processwire! =)

Wish you all a nice day (night or whatever), I'm going swimming now here :P :

http://www.bbc.co.uk...europe-10893835

  • Like 3

Share this post


Link to post
Share on other sites

Great update! I love the way it works with the tabs now. Not seeing the overflow issue anymore either. This covers about 90% of the things I use GA for. This module will get a lot of use for sure. :)

Share this post


Link to post
Share on other sites

Thank you Ryan, glad you like it!

Do you think I could implement the missing 10% somehow? :)

What do you think about resetting the custom dates?

Currently you have to check a checkbox to reset, afterwards the Module is using again the last month from today as date range (default behaviour).

Should this reset be done automatically after some time?

Share this post


Link to post
Share on other sites

Nice module, but i got lots of errors, please look at the attachment.

post-25-0-06649200-1344777410_thumb.png

Share this post


Link to post
Share on other sites

I don't see any error on your screenshot, only notices and warnings. May because debug enabled? Wanze you don't have debug on?

Share this post


Link to post
Share on other sites

Nice module, but i got lots of errors, please look at the attachment.

Hmm for some reason the module could not fetch the statistics. I need to implement a check if the results are returned correctly as an array and display an error message otherwise.

Sevraf2, were you able to choose the GA Account from the dropdown before?

Have you customized the date range or any date format settings?

Can you do some checks in the module config options:

  • Client ID, Client Secret, API Key correct?
  • Google Analytics Account Id should now have a value like "ga:xxxxxxxx"

@Soma

I have debug mode enabled, but the statistics always came up fine ;-)

Will implement the check soon!

  • Like 1

Share this post


Link to post
Share on other sites

mmm after returning to the module page the notices and warnings disappeared...btw i customized the data format into d-m-Y

Share this post


Link to post
Share on other sites

mmm after returning to the module page the notices and warnings disappeared...btw i customized the data format into d-m-Y

That's because the results were getting cached. But you still don't see any Statistics, right?

I think there has to be an error in your setup somewhere. Tested also the date "d-m-Y", works fine here on my local installation.

Will check if Google reports back some error codes in case something went wrong with the query params...

Edit:

If you want to do some more testing, you should disable caching the output:

1) Delete the folders starting with "ga_" in site/assets/cache/MarkupCache

2) In the Module Options, set Cache Time to "0"

Share this post


Link to post
Share on other sites
Do you think I could implement the missing 10% somehow? :)

The scope of Google Analytics is so broad, I don't think I'd ever expect something outside the GA app itself to implement it. Take the Real Time features for instance. You've done a great job of implementing the most important and most useful stuff. If I had to wish for anything it would only be that I could get more detail on the referrers. Like when I see a new referrer show up, I'd love to click to see the URL where the referring link actually exists. Sometimes I can't even do this in GA since it strips URL variables... leaving me to grep my access log to find the actual referring URL. But if there's some way to see not just the domain, but the path too, that would provide the same level of detail present in GA.

What do you think about resetting the custom dates? Currently you have to check a checkbox to reset, afterwards the Module is using again the last month from today as date range (default behaviour). Should this reset be done automatically after some time?

I'm not sure what the best behavior would be here, as I'm guessing everyone has their own workflow and timeline they want to look at in GA. But I do know that the first thing I do when I get into GA is to set a date range. It's rare that I want to look at the last month or year. Usually I want the last 24 hours, last 2 days, last week, etc. I've often wished that GA had a select box where I could choose "last 24 hours" for instance, rather than having to select starting and ending dates.

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
    • By MoritzLost
      Sorry for the convoluted title. I have a problem with Process modules that define a custom page using the page key through getModuleInfo (as demonstrated in this excellent tutorial by @bernhard). Those pages are created automatically when the module is installed. The problem is that the title of the page only gets set in the current language. That's not a problem if the current language (language of the superuser who is installing the module) is the default language; if it isn't, the Process page is missing a title in the default language. This has the very awkward effect that a user using the backend in the default language (or any other language) will see an empty entry in the setup menu:

      This screenshot comes from my Cache Control module which includes a Process page. Now I realize the description sounds obscure, but for us it's a common setup: We a multiple bilingual sites where the default language is German and the second language is English. While the clients use the CMS in German, as a developer I prefer the English interface, so whenever I install a Process module I get this problem.
      As a module author, is there a way to handle this situation? I guess it would be possible to use post-installation hooks or create the pages manually, but I very much prefer the declarative approach. The page title is already translatable (through the __ function), but of course at the time of installation there is no translation, and as far as I'm aware it's not possible to ship translations with a module so they are used automatically. Could this situation be handled better in the core? I would prefer if the module installation process would always set the title of the Process page in the default language, instead of the language of the current user.
×
×
  • Create New...