Wallogit.com
2017 © Pedro Peláez
library gosquared-php-sdk
thomas-dotworx/gosquared-php-sdk
- Monday, April 27, 2015
- by thomas-dotworx
- Repository
- 1 Watchers
- 0 Stars
- 1,653 Installations
- PHP
- 0 Dependents
- 0 Suggesters
- 4 Forks
- 0 Open issues
- 5 Versions
- 0 % Grown
The README.md
GoSquared PHP SDK
The official GoSquared PHP module for integrating the GoSquared API into your PHP app with ease., (*1)
Usage
Tracking API
See the Tracking API docs site for full documentation., (*2)
Reporting API
The reporting APIs and their functions are listed on Reporting API docs site., (*3)
Quick guide
require_once('gosquared-php-sdk/main.php');
$opts = array(
'site_token' => 'your-site-token',
'api_key' => 'your-api-key'
);
$GS = new GoSquared($opts);
// Track events
$result = $GS->track_event('Event Name');
// Create anonymous Person
$person = $GS->create_person();
// Identify person
$response = $person->identify('user-id', array(
'name' => 'Foo Bar',
'email' => 'foo@bar.com'
));
// Retrieve live data
$result = $GS->now->concurrents();
// Retrieve historical data
$result = $GS->trends->aggregate();
// Retrieve Ecommerce data
$result = $GS->ecommerce->transactions();
Requirements
- PHP >= 5.2.0
- cURL
Running tests
make test
To test with your own site token and api key, you can prefix this command with the SITE_TOKEN and API_KEY environment variables containing your keys. WARNING: this will track test data under your account, (*4)
Debugging
To switch on debug logs, place the following define statement before including this library:, (*5)
define('GOSQUARED_DEBUG', true);
Debug output will then be sent to the standard output streams. Common places to find the output are your console (if run with CLI), your web server logs, or php-fpm logs., (*6)