PHPackages arkaitzgarro/laravel-analytics - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. arkaitzgarro/laravel-analytics AbandonedArchivedLibrary[API Development](/categories/api) arkaitzgarro/laravel-analytics ============================== A Laravel package to retrieve Google Analytics data. 4.3.0(2y ago)080MITPHPPHP ^8.0 Since Mar 13Pushed 2y agoCompare [ Source](https://github.com/arkaitzgarro/laravel-analytics)[ Packagist](https://packagist.org/packages/arkaitzgarro/laravel-analytics)[ Docs](https://github.com/arkaitzgarro/laravel-analytics)[ Fund](https://spatie.be/open-source/support-us)[ RSS](/packages/arkaitzgarro-laravel-analytics/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (5)Dependencies (10)Versions (61)Used By (0) [![Social Card of Laravel Analytics](/art/socialcard.png)](/art/socialcard.png) Retrieve data from Google Analytics =================================== [](#retrieve-data-from-google-analytics) [![Latest Version](https://camo.githubusercontent.com/8466204fa0fcbc34f743149410057e712138991568d23bd60d2456e41743ced3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f7370617469652f6c61726176656c2d616e616c79746963732e7376673f7374796c653d666c61742d737175617265)](https://github.com/spatie/laravel-analytics/releases)[![MIT Licensed](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Check & fix styling](https://github.com/spatie/laravel-analytics/workflows/Check%20&%20fix%20styling/badge.svg)](https://github.com/spatie/laravel-analytics/workflows/Check%20&%20fix%20styling/badge.svg)[![Total Downloads](https://camo.githubusercontent.com/b59e2c97d6e46e329e91338a6281b38ec1f4ab41aaf2b3d75cf541ad3361c5eb/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7370617469652f6c61726176656c2d616e616c79746963732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/spatie/laravel-analytics) Using this package you can easily retrieve data from Google Analytics. Here are a few examples of the provided methods: ``` use Analytics; use AG\Analytics\Period; //fetch the most visited pages for today and the past week Analytics::fetchMostVisitedPages(Period::days(7)); //fetch visitors and page views for the past week Analytics::fetchVisitorsAndPageViews(Period::days(7)); ``` Most methods will return an `\Illuminate\Support\Collection` object containing the results. Support us ---------- [](#support-us) [![](https://camo.githubusercontent.com/93cbc0998d5a5183fe03b7b615f83e0379b01dc8d92ef5b2a4dad1e75e654807/68747470733a2f2f6769746875622d6164732e73332e65752d63656e7472616c2d312e616d617a6f6e6177732e636f6d2f6c61726176656c2d616e616c79746963732e6a70673f743d31)](https://spatie.be/github-ad-click/laravel-analytics) We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us). 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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards). Installation ------------ [](#installation) This package can be installed through Composer. ``` composer require spatie/laravel-analytics ``` Optionally, you can publish the config file of this package with this command: ``` php artisan vendor:publish --provider="Spatie\Analytics\AnalyticsServiceProvider" ``` The following config file will be published in `config/analytics.php` ``` return [ /* * The view id of which you want to display data. */ 'view_id' => env('ANALYTICS_VIEW_ID'), /* * Path to the client secret json file. Take a look at the README of this package * to learn how to get this file. You can also pass the credentials as an array * instead of a file path. */ 'service_account_credentials_json' => storage_path('app/analytics/service-account-credentials.json'), /* * The amount of minutes the Google API responses will be cached. * If you set this to zero, the responses won't be cached at all. */ 'cache_lifetime_in_minutes' => 60 * 24, /* * Here you may configure the "store" that the underlying Google_Client will * use to store it's data. You may also add extra parameters that will * be passed on setCacheConfig (see docs for google-api-php-client). * * Optional parameters: "lifetime", "prefix" */ 'cache' => [ 'store' => 'file', ], ]; ``` How to obtain the credentials to communicate with Google Analytics ------------------------------------------------------------------ [](#how-to-obtain-the-credentials-to-communicate-with-google-analytics) ### Getting credentials [](#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](https://console.developers.google.com/apis) and click "Select a project" in the header. [![1](https://camo.githubusercontent.com/8f7e255b8a93fa3130614a515d9d2c75e77e824d5dbb7784f127c682bc7ee025/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f312e706e67)](https://camo.githubusercontent.com/8f7e255b8a93fa3130614a515d9d2c75e77e824d5dbb7784f127c682bc7ee025/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f312e706e67) Next up we must specify which API’s the project may consume. In the list of `API Library` click "Google Analytics API". On the next screen click "Enable". [![2](https://camo.githubusercontent.com/af99fd5d33195cb7adf242e616a46b66434612ee48aeaf6048b32d77eda19b6d/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f322e706e67)](https://camo.githubusercontent.com/af99fd5d33195cb7adf242e616a46b66434612ee48aeaf6048b32d77eda19b6d/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f322e706e67) 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". [![3](https://camo.githubusercontent.com/b290d0e4a2eea70ef062000c712dcaeb2aa0af8b2a15ad30503b2795e7601640/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f332e706e67)](https://camo.githubusercontent.com/b290d0e4a2eea70ef062000c712dcaeb2aa0af8b2a15ad30503b2795e7601640/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f332e706e67) 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. [![4](https://camo.githubusercontent.com/78d86eb4665ace163956dc9a05a93b504c871abf858846d5dc0482a53b90bc79/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f342e706e67)](https://camo.githubusercontent.com/78d86eb4665ace163956dc9a05a93b504c871abf858846d5dc0482a53b90bc79/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f342e706e67) Select "JSON" as the key type and click "Create" to download the JSON file. [![5](https://camo.githubusercontent.com/ba0912185fbc145e3337f9974195eabc46ae605059ece73a366a52da1daaef88/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f352e706e67)](https://camo.githubusercontent.com/ba0912185fbc145e3337f9974195eabc46ae605059ece73a366a52da1daaef88/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f352e706e67) 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 [](#granting-permissions-to-your-analytics-property) I'm assuming that you've already created a Analytics account on the [Analytics site](https://analytics.google.com/analytics). When setting up your property, click on "Advanced options" and make sure you enable `Universal Analytics`. [![6](https://camo.githubusercontent.com/51d79bbd991f28ad8bd097167728ee9315f9def5e74e1f2887bc585b52be3c36/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f362e706e67)](https://camo.githubusercontent.com/51d79bbd991f28ad8bd097167728ee9315f9def5e74e1f2887bc585b52be3c36/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f362e706e67) Go to "User management" in the Admin-section of the property. [![7](https://camo.githubusercontent.com/f850fb7ea87995c0ea379cbc35991a37d82b48a83193b3be1d6f668ecd4044e3/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f372e706e67)](https://camo.githubusercontent.com/f850fb7ea87995c0ea379cbc35991a37d82b48a83193b3be1d6f668ecd4044e3/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f372e706e67) 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. Analyst role is enough. [![8](https://camo.githubusercontent.com/1b6ebe4d82a2292eb8bcb70b0b59776b4bac8ef3f31ecefab9975cd6e4be65ed/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f382e706e67)](https://camo.githubusercontent.com/1b6ebe4d82a2292eb8bcb70b0b59776b4bac8ef3f31ecefab9975cd6e4be65ed/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f382e706e67) ### Getting the view id [](#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](https://analytics.google.com/analytics). Go to "View setting" in the Admin-section of the property. [![9](https://camo.githubusercontent.com/35adf25b5a4ddf9b78a7fdaf882d1e9a7d191d7917ab438e5b42c8e11a72992a/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f392e706e67)](https://camo.githubusercontent.com/35adf25b5a4ddf9b78a7fdaf882d1e9a7d191d7917ab438e5b42c8e11a72992a/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f392e706e67) You'll need the `View ID` displayed there. [![10](https://camo.githubusercontent.com/9e1d1dceda01513a7bedca7d2e7067a37350cf1223461b16c7636c8bd0876a3e/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f31302e706e67)](https://camo.githubusercontent.com/9e1d1dceda01513a7bedca7d2e7067a37350cf1223461b16c7636c8bd0876a3e/68747470733a2f2f7370617469652e6769746875622e696f2f6c61726176656c2d616e616c79746963732f76342f31302e706e67) Usage ----- [](#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 ``` //retrieve visitors and pageview data for the current day and the last seven days $analyticsData = Analytics::fetchVisitorsAndPageViews(Period::days(7)); //retrieve visitors and pageviews since the 6 months ago $analyticsData = Analytics::fetchVisitorsAndPageViews(Period::months(6)); //retrieve sessions and pageviews with yearMonth dimension since 1 year ago $analyticsData = Analytics::performQuery( Period::years(1), 'ga:sessions', [ 'metrics' => 'ga:sessions, ga:pageviews', 'dimensions' => 'ga:yearMonth' ] ); ``` `$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. ``` $startDate = Carbon::now()->subYear(); $endDate = Carbon::now(); Period::create($startDate, $endDate); ``` Provided methods ---------------- [](#provided-methods) ### Visitors and pageviews [](#visitors-and-pageviews) ``` public function fetchVisitorsAndPageViews(Period $period): Collection ``` The function returns a `Collection` in which each item is an array that holds keys `date`, `visitors`, `pageTitle` and `pageViews`. ### Total visitors and pageviews [](#total-visitors-and-pageviews) ``` public function fetchTotalVisitorsAndPageViews(Period $period): Collection ``` The function returns a `Collection` in which each item is an array that holds keys `date`, `visitors`, and `pageViews`. ### Most visited pages [](#most-visited-pages) ``` public function fetchMostVisitedPages(Period $period, int $maxResults = 20): Collection ``` The function returns a `Collection` in which each item is an array that holds keys `url`, `pageTitle` and `pageViews`. ### Top referrers [](#top-referrers) ``` public function fetchTopReferrers(Period $period, int $maxResults = 20): Collection ``` The function returns a `Collection` in which each item is an array that holds keys `url` and `pageViews`. ### User Types [](#user-types) ``` public function fetchUserTypes(Period $period): Collection ``` The function returns a `Collection` in which each item is an array that holds keys `type` and `sessions`. ### Top browsers [](#top-browsers) ``` public function fetchTopBrowsers(Period $period, int $maxResults = 10): Collection ``` The function returns a `Collection` in which each item is an array that holds keys `browser` and `sessions`. ### All other Google Analytics queries [](#all-other-google-analytics-queries) To perform all other queries on the Google Analytics resource use `performQuery`. [Google's Core Reporting API](https://developers.google.com/analytics/devguides/reporting/core/v3/common-queries) provides more information on which metrics and dimensions might be used. ``` public function performQuery(Period $period, string $metrics, array $others = []) ``` You can get access to the underlying `Google_Service_Analytics` object: ``` Analytics::getAnalyticsService(); ``` Testing ------- [](#testing) Run the tests with: ``` vendor/bin/phpunit ``` Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details. Security -------- [](#security) If you've found a bug regarding security please mail instead of using the issue tracker. Credits ------- [](#credits) - [Freek Van der Herten](https://github.com/freekmurze) - [All Contributors](../../contributors) And a special thanks to [Caneco](https://twitter.com/caneco) for the logo ✨ License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 35 — LowBetter than 79% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity9 Limited adoption so far Community19 Small or concentrated contributor base Maturity82 Battle-tested with a long release history Bus Factor1 Top contributor holds 69.1% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~58 days Recently: every ~83 days Total 58 Last Release 751d ago Major Versions 0.0.1 → 1.0.02015-03-13 1.4.1 → 2.0.02016-06-20 v2.x-dev → v3.0.x-dev2017-04-27 3.11.0 → 4.0.02021-03-26 PHP version history (6 changes)0.0.1PHP >=5.5.0 1.0.2PHP >=5.4.0 2.0.0PHP ^7.0 3.7.0PHP ^7.2 3.10.2PHP ^7.3|^8.0 4.0.0PHP ^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/0c560c0d0fbc44c887877718fd41a05ce92f195bd5855ff03cc6eb472ff9f2f4?d=identicon)[arkaitzgarro](/maintainers/arkaitzgarro) --- Top Contributors [![freekmurze](https://avatars.githubusercontent.com/u/483853?v=4)](https://github.com/freekmurze "freekmurze (241 commits)")[![AlexVanderbist](https://avatars.githubusercontent.com/u/6287961?v=4)](https://github.com/AlexVanderbist "AlexVanderbist (17 commits)")[![MatthiasDeWinter](https://avatars.githubusercontent.com/u/8791525?v=4)](https://github.com/MatthiasDeWinter "MatthiasDeWinter (14 commits)")[![lukepolo](https://avatars.githubusercontent.com/u/2066668?v=4)](https://github.com/lukepolo "lukepolo (10 commits)")[![arkaitzgarro](https://avatars.githubusercontent.com/u/1712467?v=4)](https://github.com/arkaitzgarro "arkaitzgarro (10 commits)")[![juukie](https://avatars.githubusercontent.com/u/2678657?v=4)](https://github.com/juukie "juukie (8 commits)")[![AdrianMrn](https://avatars.githubusercontent.com/u/12762044?v=4)](https://github.com/AdrianMrn "AdrianMrn (7 commits)")[![sebastiandedeyne](https://avatars.githubusercontent.com/u/1561079?v=4)](https://github.com/sebastiandedeyne "sebastiandedeyne (6 commits)")[![rubenvanassche](https://avatars.githubusercontent.com/u/619804?v=4)](https://github.com/rubenvanassche "rubenvanassche (4 commits)")[![mansoorkhan96](https://avatars.githubusercontent.com/u/51432274?v=4)](https://github.com/mansoorkhan96 "mansoorkhan96 (3 commits)")[![patinthehat](https://avatars.githubusercontent.com/u/5508707?v=4)](https://github.com/patinthehat "patinthehat (3 commits)")[![laravel-shift](https://avatars.githubusercontent.com/u/15991828?v=4)](https://github.com/laravel-shift "laravel-shift (3 commits)")[![adaojunior](https://avatars.githubusercontent.com/u/4921294?v=4)](https://github.com/adaojunior "adaojunior (2 commits)")[![daveismynamecom](https://avatars.githubusercontent.com/u/60222583?v=4)](https://github.com/daveismynamecom "daveismynamecom (2 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (2 commits)")[![mbardelmeijer](https://avatars.githubusercontent.com/u/1583095?v=4)](https://github.com/mbardelmeijer "mbardelmeijer (2 commits)")[![riasvdv](https://avatars.githubusercontent.com/u/3626559?v=4)](https://github.com/riasvdv "riasvdv (2 commits)")[![Mickeel](https://avatars.githubusercontent.com/u/5862146?v=4)](https://github.com/Mickeel "Mickeel (1 commits)")[![Nielsvanpach](https://avatars.githubusercontent.com/u/10651054?v=4)](https://github.com/Nielsvanpach "Nielsvanpach (1 commits)")[![OwenMelbz](https://avatars.githubusercontent.com/u/1094740?v=4)](https://github.com/OwenMelbz "OwenMelbz (1 commits)") --- Tags spatielaravelgoogleanalyticsreportsretrieve ### Code Quality TestsPest ### Embed Badge ![Health badge](/badges/arkaitzgarro-laravel-analytics/health.svg) ``` [![Health](https://phpackages.com/badges/arkaitzgarro-laravel-analytics/health.svg)](https://phpackages.com/packages/arkaitzgarro-laravel-analytics) ``` ### Alternatives [spatie/laravel-analytics A Laravel package to retrieve Google Analytics data. 3.2k5.7M57](/packages/spatie-laravel-analytics)[thujohn/analytics Google Analytics for Laravel 4 113108.7k1](/packages/thujohn-analytics)[ozankurt/google-analytics Laravel Google Analytics 7616.7k](/packages/ozankurt-google-analytics) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)