viezel / laravel-amplitude
A Laravel package to work with Amplitude.
Requires
- php: ^8.2|^8.3
- illuminate/support: ^9.0|^10.0|^11.0
- viezel/amplitude-php-sdk: ^1.0
Requires (Dev)
- orchestra/testbench: ^7.0|^8.0|^9.0
- phpunit/phpunit: ^8.0|^9.0|^10.0|^11.0
README
Installation
composer require viezel/laravel-amplitude
The AMPLITUDE_API_URL is either US or EU based. Please pay attention.
AMPLITUDE_API_KEY= AMPLITUDE_API_URL=https://api.eu.amplitude.com/2/httpapi
'aliases' => [ ... 'Amplitude' => LaravelAmplitude\Facades\Amplitude::class ]
Usage
Laravel Amplitude uses a simple syntax to track your product events easily.
Setting the User Id
First of all, before sending anything, you will need to set the User ID.
Amplitude::setUserId('user_id');
Note: setting the user id is MANDATORY. Otherwise, you will get an error when trying to send data to Amplitude.
Sending Events
Once the user id is set, you are ready to send events to your Amplitude project.
// simple sending... Amplitude::sendEvent('app_opened'); // sending with properties... Amplitude::sendEvent('subscription_paid', ['was_trial' => true]);
Also, you can change the user properties with the dedicated method setUserProperties:
// properties new values are set here Amplitude::setUserProperties([ 'trial' => false, 'plan' => 'professional' ]); // data is sent to Amplitude here Amplitude::sendEvent('subscription_paid', ['was_trial' => true]);
IMPORTANT: the properties will be sent to Amplitude at the next sendEvent call. Without any other call to sendEvent, the new user properties are not going to be saved.
Queueing Events
If send a lot of events and you want to keep your performances good, you may choose events queueing instead of the simple sending you just saw.
With events queueing, you will send all your events once the request is over, instead of making different API calls during the request lifecycle.
To use it, just switch your sendEvent calls to queueEvent method.
// simple sending... Amplitude::queueEvent('app_opened'); // sending with properties... Amplitude::queueEvent('subscription_paid', ['was_trial' => true]);
Nothing more to do! When the request will be finished, Laravel Amplitude will automatically trigger the send operation of your data.
However, if you want more control and you want to send your queued events in your code, you can do it manually with a call to the sendQueuedEvents method.
// queueing an event... Amplitude::queueEvent('app_opened'); // queueing another event... Amplitude::queueEvent('subscription_paid', ['was_trial' => true]); // send them! Amplitude::sendQueuedEvents();