deseretdigital/cxense-insight-php-sdk

This package is abandoned and no longer maintained. No replacement package was suggested.

Library for interfacing with the Cxense Insight API

v2.4.0 2017-09-08 03:19 UTC

Requires

• guzzlehttp/guzzle: ~6.1

Requires (Dev)

• codacy/coverage: ~1.0
• mockery/mockery: ~0.9
• phpunit/phpunit: ~5.0
• raveren/kint: ~1.0

MIT

• Mark Lind
• Nate Christensen
• Russell Ahlstrom

• cxense
• insight

README

Installation via composer

In composer.json Add the SDK to your require:

"require": {
    "deseretdigital/cxense-insight-php-sdk": "~2.1"
}

Run composer install

If you're not familiar with composer you can read up on it here https://getcomposer.org/

Usage

include __DIR__ . '/vendor/autoload.php';

use CxInsightSDK\Traffic;

$traffic = new Traffic(
    '[e-mail]',
    'apikey'
);

// Get data for one week's time
$options = [
    'start' => strtotime('-1 week'),
    'stop' => time(),
    'fields' => [
        'events',
        'uniqueUsers',
        'urls',
        'activeTime',
        'sessionStarts',
        'sessionStops',
        'sessionBounces'
    ],
    'filters' => [
        [
            'type' => 'event',
            'group' => 'url',
            'items'  => ['http://example.com']
        ]
    ],
    'siteIds' => [
        'siteId'
    ]
];

$data = $traffic->getData($options);

For more information on options/parameters that can be sent to the cxense API see the Cxense API Wiki.

NOTE: Currently this sDK only supports the following cxense API endpoints (additional endpoints can easily be added): /traffic, /traffic/event, /traffic/data, /traffic/custom, /dmp/traffic, /dmp/traffic/event, /dmp/traffic/custom, /document/search, /document/update, /profile/content/delete, /reports/search, /reports/search/usage