A PHP library for reporting events to the Keen IO API
The Keen IO API lets developers build analytics features directly into their apps.
$ php composer.phar require keen-io/keen-io:~2.5
For composer documentation, please refer to getcomposer.org.
For easier usage the following community developed integrations are also available:
Please review the change log ( CHANGE.md ) before upgrading!
This client was built using Guzzle, a PHP HTTP client & framework for building RESTful web service clients.
When you first create a new
KeenIOClient instance you can pass configuration settings like your Project ID and API Keys in an array
to the factory method. These are optional and can be later specified through Setter methods.
For certain API Resources, the Master API Key is required and can also be passed to the factory method in the configuration array. Please read the Security Documentation regarding this Master API key.
For Requests, the
KeenIOClient will determine what API Key should be passed based on the type of Request and configuration in the
Service Description. The API Key is passed in the
Authorization header of the request.
For a list of required and available parameters for the different API Endpoints, please consult the Keen IO API Reference Docs.
The factory method accepts an array of configuration settings for the Keen IO Webservice Client.
||The Keen IO Project ID for your specific project|
|Master API Key||
||The Keen IO Master API Key - the one API key to rule them all|
|Read API Key||
||The Read API Key - used for access to read only GET or HEAD operations of the API|
|Write API Key||
||The Write API Key - used for write PUT or POST Requests operations of the API|
||The API Version. Currently used to version the API URL and Service Description|
version to the factory method or using the
setVersion() method, the Client will try to load a client Service Description
that matches that version. That Service Description defines the operations available to the Webservice Client.
Currently the Keen IO Webservice Client only supports - and automatically defaults - to the current version (
3.0) of the API.
Since the Keen client extends the Guzzle client, you get all the power and flexibility of that behind the scenes. If you need more complex logging, backoff/retry handling, or asynchronous requests, check out their Plugins.
use KeenIO\Client\KeenIOClient; $client = KeenIOClient::factory([ 'projectId' => $projectId, 'writeKey' => $writeKey, 'readKey' => $readKey ]);
You can reconfigure the Keen IO Client configuration options through available getters and setters. You can get and set the following options:
//Get the current Project Id $client->getProjectId(); //Set a new Project Id $client->setProjectId($someNewProjectId); //Get the current Read Key $client->getReadKey(); //Set a new Read Key $newReadKey = $client->createScopedKey($filters, $allowedOperations); $client->setReadKey($newReadKey);
Send an event to Keen - (Changed in 2.0!)
Once you've created a
KeenIOClient, sending events is simple:
$event = ['purchase' => ['item' => 'Golden Elephant']]; $client->addEvent('purchases', $event);
Send batched events to Keen - (Changed in 2.0!)
You can upload multiple Events to multiple Event Collections at once!
In the example below, we will create two new purchase events in the
purchases event collection and a single
new event in the
sign_ups event collection. Note that the keys of the
data array specify the
where those events should be stored.
$purchases = [ ['purchase' => ['item' => 'Golden Elephant']], ['purchase' => ['item' => 'Magenta Elephant']] ]; $signUps = [ ['name' => 'foo', 'email' => 'firstname.lastname@example.org'] ]; $client->addEvents(['purchases' => $purchases, 'sign_ups' => $signUps]);
Below are a few example calls to some of the Analysis methods available.
Note: Once the API acknowledges that your event has been stored, it may take up to 10 seconds before it will appear in query results.
//Count $totalPurchases = $client->count('purchases', ['timeframe' => 'this_14_days']); //Count Unqiue $totalItems = $client->countUnique('purchases', ['target_property' => 'purchase.item', 'timeframe' => 'this_14_days']); //Select Unique $items = $client->selectUnique('purchases', ['target_property' => 'purchase.item', 'timeframe' => 'this_14_days']); //Multi Analysis $analyses = [ 'clicks' => ['analysis_type' => 'count'], 'average price' => ['analysis_type' => 'average', 'target_property' => 'purchase.price'], 'timeframe' => 'this_14_days' ]; $stats = $client->multiAnalysis('purchases', ['analyses' => $analyses]); //Using Filters in your Analysis $filters = [ ['property_name' => 'item.price', 'operator' => 'gt', 'property_value' => 10] ]; $client->count('purchases', ['filters' => $filters, 'timeframe' => 'this_14_days']);
Scoped keys allow you to secure the requests to the API Endpoints and are especially useful when you are providing access to multiple clients or applications. You should read the Keen IO docs concerning Scoped Keys for more details.
$filter = [ 'property_name' => 'user_id', 'operator' => 'eq', 'property_value' => '123' ]; $filters = [$filter]; $allowedOperations = ['read']; $scopedKey = $client->createScopedKey($filters, $allowedOperations);
Saved Queries allow you to perform with exactly the same parameters every time with minimal effort. It's effectively a bookmark or macro to analysis that you can jump to or share without configuring each time. While you can create and access them via the Dashboard, the PHP library gives you the same ability.
$client = KeenIOClient::factory([ 'projectId' => $project_id, 'masterKey' => $master_key ]); $query = [ "analysis_type" => "count", "event_collection" => "api_requests", "filters" => [ [ "property_name" => "user_agent", "operator" => "ne", "property_value"=> "Pingdom.com_bot_version_1.4_(http://www.pingdom.com/)" ] ], "timeframe" => "this_2_weeks" ]; $results = $client->createSavedQuery(['query_name' => 'total-API-requests', 'query' => $query]);
$client = KeenIOClient::factory([ 'projectId' => $project_id, 'masterKey' => $master_key ]); $results = $client->getSavedQuery(['query_name' => 'total-API-requests']);
If you have any questions, bugs, or suggestions, please report them via Github Issues. Or, come chat with us anytime at users.keen.io. We'd love to hear your feedback and ideas!
This is an open source project and we love involvement from the community! Hit us up with pull requests and issues.