README

Aimtell offers a service for push notifications to users who give permission. This package allows for interfacing with Aimtell's backend API to manage your account.

Aimtell REST API Documentation

Installation

You can install the package via composer:

composer require collinped/laravel-aimtell

You can publish and run the migrations with:

You can publish the config file with:

php artisan vendor:publish --provider="Collinped\LaravelAimtell\AimtellServiceProvider" --tag="config"

This is the contents of the published config file:

return [
    'api_key' => env('AIMTELL_API_KEY'), // Required - API Key Provided by Aimtell
    'default_site_id' => env('AIMTELL_DEFAULT_SITE_ID'), // Recommended
    'white_label_id' => env('AIMTELL_WHITE_LABEL_ID'), // Must contact Aimtell for White Label ID
];

Usage

Quick Example

$site = aimtell()->site()
                ->create([
                    'name' => 'Sample Website',
                    'url' => 'collinped.com'
                ]);

$campaigns = aimtell()->site($siteId)
                     ->campaign()
                     ->all();

$campaign = aimtell()->site($siteId)
                    ->campaign()
                    ->find($campaignId);

Testing

composer test

Todo

A/B Tests for Manual Campaigns
Create Manual Campaign (Batch)
Update Manual Campaign (Batch)
Delete Manual Campaign (Batch)
Create Event Triggered Campaign (Batch)
Update Event Triggered Campaign (Batch)
Delete Event Triggered Campaign (Batch)
Get Notification Logs
Get Attributes Logs
Get Pageview Logs
Get Event Logs

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

License

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

collinped / laravel-aimtell

Maintainers

Details