PHPackages                             bdmotaleb/traclytics-client - 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. bdmotaleb/traclytics-client

ActiveLibrary[API Development](/categories/api)

bdmotaleb/traclytics-client
===========================

Lightweight PHP client for Traclytics API

v1.4.0(7mo ago)177MITPHPPHP >=7.0

Since Nov 12Pushed 6mo agoCompare

[ Source](https://github.com/bdmotaleb/traclytics-client)[ Packagist](https://packagist.org/packages/bdmotaleb/traclytics-client)[ Docs](https://github.com/bdmotaleb/traclytics-client)[ RSS](/packages/bdmotaleb-traclytics-client/feed)WikiDiscussions main Synced 3w ago

READMEChangelogDependencies (3)Versions (6)Used By (0)

Traclytics Client
=================

[](#traclytics-client)

Lightweight PHP client for Traclytics API with Laravel support. Uses ext-curl. No extra dependencies.

Features
--------

[](#features)

- ✅ Simple and lightweight
- ✅ Laravel Service Provider with auto-discovery
- ✅ Configurable via environment variables or config files
- ✅ HRIS mode with automatic department tracking
- ✅ Custom user ID and user name key support
- ✅ Automatic retry logic with exponential backoff
- ✅ Works with Laravel and plain PHP

Quick Start
-----------

[](#quick-start)

### Laravel Quick Start

[](#laravel-quick-start)

#### 1. Install the Package

[](#1-install-the-package)

```
composer require bdmotaleb/traclytics-client
```

#### 2. Publish Configuration (Optional)

[](#2-publish-configuration-optional)

```
php artisan vendor:publish --provider="Traclytics\TraclyticsServiceProvider"
```

#### 3. Add Environment Variables

[](#3-add-environment-variables)

Add these to your `.env` file:

```
TRACLYTICS_PROJECT_KEY=your-project-key
TRACLYTICS_ACCESS_TOKEN=your-access-token

TRACLYTICS_USER_ID_KEY=user_id
TRACLYTICS_USER_NAME_KEY=user_name
TRACLYTICS_IS_HRIS=false
TRACLYTICS_DEPARTMENT_KEY=department
TRACLYTICS_IS_ENABLE=true
```

#### 4. Start Tracking Events

[](#4-start-tracking-events)

```
use Traclytics\Facades\Traclytics;

// In any controller, route, or service
Traclytics::track([
    'event_type' => 'user_login',
    'action_type' => 'authentication',
    'details' => [
        'method' => 'email',
    ]
]);
```

That's it! 🎉 Your events are now being tracked.

---

### Plain PHP Quick Start

[](#plain-php-quick-start)

#### 1. Install the Package

[](#1-install-the-package-1)

```
composer require bdmotaleb/traclytics-client
composer dump-autoload
```

#### 2. Set Environment Variables

[](#2-set-environment-variables)

Create a `.env` file or set environment variables:

```
TRACLYTICS_PROJECT_KEY=your-project-key-here
TRACLYTICS_ACCESS_TOKEN=your-access-token-here

# Optional - defaults shown
TRACLYTICS_USER_ID_KEY=user_id
TRACLYTICS_USER_NAME_KEY=user_name
TRACLYTICS_IS_HRIS=false
TRACLYTICS_DEPARTMENT_KEY=department
TRACLYTICS_IS_ENABLE=true
```

#### 3. Start Tracking Events

[](#3-start-tracking-events)

```