Download the PHP package jfelixstudio/lumen-analytics without Composer
On this page you can find all versions of the php package jfelixstudio/lumen-analytics. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jfelixstudio/lumen-analytics
More information about jfelixstudio/lumen-analytics
Files in jfelixstudio/lumen-analytics
Package lumen-analytics
Short Description A lumen package to retrieve Google Analytics data.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package lumen-analytics
Retrieve data from Google Analytics
Using this package you can easily retrieve data from Google Analytics.
Here are a few examples of the provided methods:
Most methods will return an \Illuminate\Support\Collection object containing the results.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
This package can be installed through Composer.
Optionally, you can publish the config file of this package with this command:
The following config file will be published in config/analytics.php
How to obtain the credentials to communicate with Google Analytics
Getting credentials
The first thing you’ll need to do is to get some credentials to use Google API’s. I’m assuming that you’ve already created a Google account and are signed in. Head over to Google API’s site and click "Select a project" in the header.
Next up we must specify which API’s the project may consume. In the list of available API’s click "Google Analytics API". On the next screen click "Enable".
Now that you’ve created a project that has access to the Analytics API it’s time to download a file with these credentials. Click "Credentials" in the sidebar. You’ll want to create a "Service account key".
On the next screen you can give the service account a name. You can name it anything you’d like. In the service account id you’ll see an email address. We’ll use this email address later on in this guide. Select "JSON" as the key type and click "Create" to download the JSON file.
Save the json inside your Laravel project at the location specified in the service_account_credentials_json key of the config file of this package. Because the json file contains potentially sensitive information I don't recommend committing it to your git repository.
Granting permissions to your Analytics property
I'm assuming that you've already created a Analytics account on the Analytics site. Go to "User management" in the Admin-section of the property.
On this screen you can grant access to the email address found in the client_email key from the json file you download in the previous step. Read only access is enough.
Getting the view id
The last thing you'll have to do is fill in the view_id in the config file. You can get the right value on the Analytics site. Go to "View setting" in the Admin-section of the property.
You'll need the View ID displayed there.
Usage
When the installation is done you can easily retrieve Analytics data. Nearly all methods will return an Illuminate\Support\Collection-instance.
Here are a few examples using periods
$analyticsData is a Collection in which each item is an array that holds keys date, visitors and pageViews
If you want to have more control over the period you want to fetch data for, you can pass a startDate and an endDate to the period object.
Provided methods
Visitors and pageviews
The function returns a Collection in which each item is an array that holds keys date, visitors, pageTitle and pageViews.
Total visitors and pageviews
The function returns a Collection in which each item is an array that holds keys date, visitors, and pageViews.
Most visited pages
The function returns a Collection in which each item is an array that holds keys url, pageTitle and pageViews.
Top referrers
The function returns a Collection in which each item is an array that holds keys url and pageViews.
User Types
The function returns a Collection in which each item is an array that holds keys type and sessions.
Top browsers
The function returns a Collection in which each item is an array that holds keys browser and sessions.
All other Google Analytics queries
To perform all other queries on the Google Analytics resource use performQuery. Google's Core Reporting API provides more information on which metrics and dimensions might be used.
You can get access to the underlying Google_Service_Analytics object:
Testing
Run the tests with:
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Freek Van der Herten
- All Contributors
And a special thanks to Caneco for the logo ✨
License
The MIT License (MIT). Please see License File for more information.
All versions of lumen-analytics with dependencies
google/apiclient Version ^2.0|^2.7
illuminate/support Version ^7.0|^8.0
illuminate/contracts Version ^7.0|^8.0
nesbot/carbon Version ^2.0
spatie/laravel-package-tools Version ^1.6
symfony/cache Version ^4.3|^5.0