How to track a new user

Now that you've installed the SimpleStats client package, you can finally start tracking your users! Don't worry, it's super simple.

Configuration

If you for any reason do not use the default user model from Laravel, you may define your user model to track here:

//config/simplestats-client.php

    'tracking_types' => [
        // ...
        
        'user' => [
            'model' => App\Models\Account::class,
        ],
        
        // ...
    ],

User Tracking

To track a new user/registration, the only thing you have to do is to add the TrackablePerson contract to your User model and then implement the methods defined in the contract.

It may look like this:

use SimpleStatsIo\LaravelClient\Contracts\TrackablePerson;

class User extends Authenticatable implements TrackablePerson
{
    // ...
    
    /**
     * The time when the user has registered.
     */
    public function getTrackingTime(): CarbonInterface
    {
        return $this->created_at;
    }
    
    // ...
}

Now each time a new User model gets created, an API request is sent to SimpleStats to count a new registration.

INFO

You may tweak the getTrackingTime method to your needs. For instance, if your created_at field is named differently you have to ajust it in the method.

With Condition

Sometimes you may not want to count a newly created user immediately as a "valid" registration. For such cases, the TrackablePersonWithCondition contract is designed to be utilized. Use it if you want to track/count a new registration only when a certain condition is fulfilled, such as the user has verified their email address.

use SimpleStatsIo\LaravelClient\Contracts\TrackablePersonWithCondition;

class User extends Authenticatable implements TrackablePersonWithCondition
{
    // ...

    /**
     * The condition that should be fulfilled in order to track the user.
     */
    public function passTrackingCondition(): bool
    {
        return $this->email_verified_at != NULL;
    }

    /**
     * The field(s) we should watch for changes to recheck the condition.
     */
    public function watchTrackingFields(): array
    {
        return ['email_verified_at'];
    }
    
    // ...
}

INFO

Now, as soon as the user verified their email address and the email_verified_at field changes for instance from NULL to a date, the user gets tracked and counted. You may tweak these methods completely to your needs!

TIP

You can check as many fields as you like and apply any logic you want here.