Merge pull request #36 from PromInc/Page-Level-Reporting

Page level reporting

Author: PromInc

.gitignore

@@ -1,2 +1,2 @@
-organic-search-analytics/config/
-*.p12
+*.p12
+.DS_STORE

CHANGELOG.md

@@ -1,3 +1,43 @@
+## 2.5.0 - 2017-04-06
+### Reports
+- Add page data to the report
+- Convert query into a link to Google
+- Chart bug fixes
+- Stylized display of applied report parameters
+- Linked relevant applied report parameters
+- Link between relevant reports in the report table
+- Added tooltips to column headings
+- Correct inaccuracy in average_position calculation
+- Fix Date reports with granularity of Week, Month, and Year set
+
+### Database updates
+- Alter search_analytics table for improved data storage and analysis
+	- avg_position from int(11) to float, default NULL
+	- avg_position_click from int(11) to float
+	- default of null for device_type, country, and query columns
+	- add page column
+	- change database charset for wider language compatibility
+	- add settings table
+
+### Added
+- Added page level data in capture from Google and reporting
+- Added debug logger
+- Added the config and log directories to the repository so it isn’t necessary to add it on setup
+
+### Changed
+- Update Font Awesome to 4.7.0
+- Minor style updates throughout the site
+- Installation sql script to reflect new database structure
+- Upgrade script to reflect these database and file system changes
+
+### Fixes/Closes Github Issues
+- #13
+- #16
+- #28
+- #31
+- #32
+- #35
+
 ## 2.4.3 - 2016-07-01
 ### Bug Fix
 - Data Capture would not import any records for new installs (non-upgraded) of this tool.  A MySQL error was thrown in the background due to a field not being available in the database.

README.md

@@ -1,23 +1,15 @@
 # Organic Search Analytics Importer
-## Version 2.3.7 Now Available!!! (January 12th, 2016)
-**Official Release Version**
-> This is a highly recommended update for all users.  This update fixes a bug where queries from Google that contain special characters are not being saved to the database.  It is suggested that you update to this version immediately.
+## Version 2.5.0 Now Available!!! (April 6th, 2017)
+### New Features
+- Choose which dimensions to capture in the settings
+- Capture Page from Google Search Analytics
+- Reporting Bug Fixes and Enhancements
 
-> Once updated, there is a **Delete Data** option found on the home page.  This page can be used to delete data that was affected by this bug.  Once deleted, you can re-capture data for that date.  This process ensures your data is as accurate as possible.
-
-## Version 2.4.0
-**Current Master Branch**
-At this time, the current master branch has been updated to 2.4.0 and not commited as an official release.
-
-This update adds the country field, as requested in Issue #11.
-
-> **Notice** You will need to run an update script from the home page for this version to run smoothly as it needs to update the database.  Go to the homepage of your installation, choose **Upgrade Scripts** and then choose **Run Update for Version 2.x.x to 2.4.0**.  Failure to run this script will result in undesired results across the utility.
-
-> The update script performs a database update to add the *country* column.
+> **Notice** You will need to run an update script from the home page for this version to run smoothly as it needs to update the database.  Go to the homepage of your installation, choose **Upgrade Scripts** and then choose **Run Update for Version 2.x.x to 2.5.0**.  Failure to run this script will result in undesired results across the utility.
 
 
 ## Features
-Import organic search analytics from Google Search Console (Google Webmaster Tools) and Bing Search Keywords (Bing Webmaster Tools) into a local database to keep a historical, local, and combined record of your (past the 30 days that Google offers).
+Import organic search analytics from Google Search Console (Google Webmaster Tools) and Bing Search Keywords (Bing Webmaster Tools) into a local database to keep a historical, local, and combined record of your (past the 90 days that Google offers).
 
 This archive of organic search analytics will allow you to study long term SEO trends and shifts and can help to monitor and gauge performance of a websites over time.
 

organic-search-analytics.sql

@@ -33,7 +33,7 @@ CREATE TABLE IF NOT EXISTS `report_saved` (
   `category` int(11) NOT NULL,
   `paramaters` varchar(1000) NOT NULL,
   PRIMARY KEY (`id`)
-) ENGINE=InnoDB  DEFAULT CHARSET=latin1 AUTO_INCREMENT=0 ;
+) ENGINE=InnoDB  DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci AUTO_INCREMENT=0 ;
 
 -- --------------------------------------------------------
 
@@ -46,7 +46,7 @@ CREATE TABLE IF NOT EXISTS `report_saved_categories` (
   `name` varchar(256) NOT NULL,
   `description` varchar(1000) NOT NULL,
   PRIMARY KEY (`id`)
-) ENGINE=InnoDB  DEFAULT CHARSET=latin1 AUTO_INCREMENT=0 ;
+) ENGINE=InnoDB  DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci AUTO_INCREMENT=0 ;
 
 -- --------------------------------------------------------
 
@@ -60,16 +60,17 @@ CREATE TABLE IF NOT EXISTS `search_analytics` (
   `date` date NOT NULL,
   `search_engine` varchar(50) NOT NULL,
   `search_type` varchar(24) NOT NULL,
-  `device_type` varchar(24) NOT NULL,
-  `country` varchar(10) NULL,
-  `query` varchar(500) NOT NULL,
+  `device_type` varchar(24) NULL DEFAULT NULL,
+  `country` varchar(10) NULL DEFAULT NULL,
+  `query` varchar(500) NULL DEFAULT NULL,
+  `page` VARCHAR(500) NULL DEFAULT NULL,
   `impressions` int(11) NOT NULL,
   `clicks` int(11) NOT NULL,
   `ctr` float NOT NULL,
-  `avg_position` int(11) NOT NULL,
-  `avg_position_click` int(11) NULL,
+  `avg_position` float NOT NULL,
+  `avg_position_click` float NULL,
   PRIMARY KEY (`id`)
-) ENGINE=MyISAM  DEFAULT CHARSET=latin1 AUTO_INCREMENT=0 ;
+) ENGINE=MyISAM  DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci AUTO_INCREMENT=0 ;
 
 -- --------------------------------------------------------
 
@@ -83,7 +84,15 @@ CREATE TABLE IF NOT EXISTS `settings` (
   `value` varchar(256) NOT NULL,
   `data` varchar(500) NOT NULL,
   PRIMARY KEY (`id`)
-) ENGINE=MyISAM  DEFAULT CHARSET=latin1 AUTO_INCREMENT=0 ;
+) ENGINE=InnoDB  DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci AUTO_INCREMENT=0 ;
+
+INSERT INTO `settings`
+	(type, value, data)
+VALUES
+	('settings', 'google_search_console_dimensions_query', 'On'),
+	('settings', 'google_search_console_dimensions_page', 'Off'),
+	('settings', 'google_search_console_dimensions_device', 'On'),
+	('settings', 'google_search_console_dimensions_country', 'On') ;
 
 /*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
 /*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;

organic-search-analytics/config/.gitignore

@@ -0,0 +1,3 @@
+*
+*/
+!.gitignore