#Laravel Optimizely

A PHP/Laravel client for the Optimizely REST API v2. Covers projects, experiments, campaigns, audiences, events and pages through a simple, typed API built on Laravel's Http client.

#Features

• Projects: list, get, create, update
• Experiments: list (with status filter), get, create, update, results, archive
• Campaigns: list, get, results
• Audiences: list, get
• Events and Pages: list
• A default project id from config, so every scoped call can omit it
• Throws OptimizelyException (with the original API error body) on any non-2xx response

#Installation

You can install the package via composer:

composer require jeffersongoncalves/laravel-optimizely

Publish the config file:

php artisan vendor:publish --tag=optimizely-config

Set your Optimizely credentials in .env:

OPTIMIZELY_API_KEY=your-personal-access-token
OPTIMIZELY_PROJECT_ID=1234

Generate the token under Profile > API Access in your Optimizely account.

#Configuration

// config/optimizely.php
return [
    'api_key' => env('OPTIMIZELY_API_KEY', ''),
    'base_url' => env('OPTIMIZELY_BASE_URL', 'https://api.optimizely.com/v2'),
    'project_id' => env('OPTIMIZELY_PROJECT_ID'),
    'default_per_page' => env('OPTIMIZELY_DEFAULT_PER_PAGE', 25),
];

#Usage

The package is resolved via the Optimizely facade or by injecting JeffersonGoncalves\Optimizely\Optimizely. Each API group is exposed as a method returning a dedicated resource class.

#Projects

use JeffersonGoncalves\Optimizely\Facades\Optimizely;

$projects = Optimizely::projects()->list(page: 1, perPage: 50);
$project = Optimizely::projects()->get(1234);
$created = Optimizely::projects()->create('Marketing Site', platform: 'web');
$updated = Optimizely::projects()->update(1234, ['name' => 'Marketing Site v2']);

#Experiments

// Omits the project id — falls back to config('optimizely.project_id')
$experiments = Optimizely::experiments()->list(status: 'running');

$experiment = Optimizely::experiments()->get(555);

$created = Optimizely::experiments()->create(
    name: 'Homepage CTA',
    type: 'a/b',
    trafficAllocation: 5000,
);

$updated = Optimizely::experiments()->update(555, ['status' => 'paused']);
$results = Optimizely::experiments()->results(555, '2026-01-01', '2026-01-31');
$archived = Optimizely::experiments()->archive(555);

#Campaigns, audiences, events and pages

$campaigns = Optimizely::campaigns()->list();
$campaign = Optimizely::campaigns()->get(777);
$results = Optimizely::campaigns()->results(777);

$audiences = Optimizely::audiences()->list();
$audience = Optimizely::audiences()->get(888);

$events = Optimizely::events()->list();
$pages = Optimizely::pages()->list();

// Any scoped resource accepts an explicit project id as the first argument
$events = Optimizely::events()->list(projectId: 4321);

#Error handling

Any non-2xx API response throws JeffersonGoncalves\Optimizely\Exceptions\OptimizelyException, which exposes the decoded error body:

use JeffersonGoncalves\Optimizely\Exceptions\OptimizelyException;

try {
    Optimizely::experiments()->get(1);
} catch (OptimizelyException $e) {
    logger()->error($e->getMessage(), $e->errorBody());
}

Calling a scoped resource with no project id — neither passed nor configured — throws InvalidArgumentException before any HTTP call is made.

#Testing

composer test

#Changelog

Please see CHANGELOG for more information on what has changed recently.

#Contributing

Please see CONTRIBUTING for details.

#Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

#Credits

• Jefferson Gonçalves
• All Contributors

#License

The MIT License (MIT). Please see License File for more information.