Event Server is designed to collect data into Apache PredictionIO in an event-based style. Once the Event Server is launched, your application can send data to it through its Event API with HTTP requests or with EventClients of PredictionIO's SDKs.

Launching the Event Server

Everything about Apache PredictionIO can be done through the pio command. Please add PIO binary command path to to your PATH first. Assuming PredictionIO is installed at /home/yourname/PredictionIO/, you can run

1

$ PATH=$PATH:/home/yourname/PredictionIO/bin; export PATH

To start the event server, run

1

$ pio eventserver

Check Server Status

1

$ curl -i -X GET http://localhost:7070

Sample response:

1
2
3
4
5
6
7

HTTP/1.1 200 OK
Server: akka-http/10.1.5
Date: Wed, 10 Sep 2014 22:37:30 GMT
Content-Type: application/json; charset=UTF-8
Content-Length: 18

{"status":"alive"}

Generating App ID and Access Key

First, you need to create a new app in the Event Server. You will later send data into it.

1

$ pio app new MyTestApp

You can replace MyTestApp with name of your App.

Take note of the Access Key and App ID generated. You need the Access Key to use the Event API. You should see something like the following output:

1
2
3
4

[INFO] [App$] Created new app:
[INFO] [App$]         Name: MyTestApp
[INFO] [App$]           ID: 6
[INFO] [App$]   Access Key: WPgcXKd42FPQpZHVbVeMyqF4CQJUnXQmIMTHhX3ZUrSzvy1KXJjdFUrslifa9rnB

Creating Your First Event

You may connect to the Event Server with HTTP request or by using one of many Apache PredictionIO SDKs.

For example, the following shows how one can create an event involving a single entity. Replace the value of accessKey by the Access Key generated for your App.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

$ curl -i -X POST http://localhost:7070/events.json?accessKey=WPgcXKd42FPQpZHVbVeMyqF4CQJUnXQmIMTHhX3ZUrSzvy1KXJjdFUrslifa9rnB \
-H "Content-Type: application/json" \
-d '{
  "event" : "my_event",
  "entityType" : "user",
  "entityId" : "uid",
  "properties" : {
    "prop1" : 1,
    "prop2" : "value2",
    "prop3" : [1, 2, 3],
    "prop4" : true,
    "prop5" : ["a", "b", "c"],
    "prop6" : 4.56
  }
  "eventTime" : "2004-12-13T21:39:45.618-07:00"
}'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

<?php
  require_once("vendor/autoload.php");

  use predictionio\EventClient;

  $accessKey = 'YOUR_ACCESS_KEY';
  $client = new EventClient($accessKey);
  $response = $client->createEvent(array(
                        'event' => 'my_event',
                        'entityType' => 'user',
                        'entityId' => 'uid',
                        'properties' => array('prop1' => 1,
                                              'prop2' => 'value2',
                                              'prop3' => array(1,2,3),
                                              'prop4' => true,
                                              'prop5' => array('a','b','c'),
                                              'prop6' => 4.56
                                        ),
                        'eventTime' => '2004-12-13T21:39:45.618-07:00'
                       ));
?>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

from predictionio import EventClient
from datetime import datetime
import pytz
client = EventClient('YOUR_ACCESS_KEY', "http://localhost:7070")

first_event_properties = {
    "prop1" : 1,
    "prop2" : "value2",
    "prop3" : [1, 2, 3],
    "prop4" : True,
    "prop5" : ["a", "b", "c"],
    "prop6" : 4.56 ,
    }
first_event_time = datetime(
  2004, 12, 13, 21, 39, 45, 618000, pytz.timezone('US/Mountain'))
first_event_response = client.create_event(
    event="my_event",
    entity_type="user",
    entity_id="uid",
    properties=first_event_properties,
    event_time=first_event_time,
)

1
2
3
4
5
6
7
8
9
10
11

require 'predictionio'

event_client = PredictionIO::EventClient.new('YOUR_ACCESS_KEY')
event_client.create_event('my_event', 'user', 'uid',
                          'eventTime' => '2004-12-13T21:39:45.618-07:00',
                          'properties' => { 'prop1' => 1,
                                            'prop2' => 'value2',
                                            'prop3' => [1, 2, 3],
                                            'prop4' => true,
                                            'prop5' => %w(a b c),
                                            'prop6' => 4.56 })

1

(coming soon)

For example, the following shows how one can create an event involving two entities (with targetEntity).

1
2
3
4
5
6
7
8
9
10
11
12
13
14

$ curl -i -X POST http://localhost:7070/events.json?accessKey=WPgcXKd42FPQpZHVbVeMyqF4CQJUnXQmIMTHhX3ZUrSzvy1KXJjdFUrslifa9rnB \
-H "Content-Type: application/json" \
-d '{
  "event" : "my_event",
  "entityType" : "user",
  "entityId" : "uid",
  "targetEntityType" : "item",
  "targetEntityId" : "iid",
  "properties" : {
    "someProperty" : "value1",
    "anotherProperty" : "value2"
  },
  "eventTime" : "2004-12-13T21:39:45.618Z"
}'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

<?php
  require_once("vendor/autoload.php");

  use predictionio\EventClient;

  $accessKey = 'YOUR_ACCESS_KEY';
  $client = new EventClient($accessKey);
  $response = $client->createEvent(array(
                        'event' => 'my_event',
                        'entityType' => 'user',
                        'entityId' => 'uid',
                        'targetEntityType' => 'item',
                        'targetEntityId' => 'iid',
                        'properties' => array('someProperty'=>'value1',
                                              'anotherProperty'=>'value2'),
                        'eventTime' => '2004-12-13T21:39:45.618Z'
                       ));
?>

1
2
3
4
5
6
7
8
9
10
11
12
13

# Second Event
second_event_properties = {
    "someProperty" : "value1",
    "anotherProperty" : "value2",
    }
second_event_response = client.create_event(
    event="my_event",
    entity_type="user",
    entity_id="uid",
    target_entity_type="item",
    target_entity_id="iid",
    properties=second_event_properties,
    event_time=datetime(2014, 12, 13, 21, 38, 45, 618000, pytz.utc))

1
2
3
4
5
6
7
8
9

require 'predictionio'

event_client = PredictionIO::EventClient.new('YOUR_ACCESS_KEY')
event_client.create_event('my_event', 'user', 'uid',
                          'targetEntityType' => 'item',
                          'targetEntityId' => 'iid',
                          'eventTime' => '2004-12-13T21:39:45.618Z',
                          'properties' => { 'someProperty' => 'value1',
                                            'anotherProperty' => 'value2' })

1

(coming soon)

Sample response:

1
2
3
4
5
6
7

HTTP/1.1 201 Created
Server: akka-http/10.1.5
Date: Wed, 10 Sep 2014 22:51:33 GMT
Content-Type: application/json; charset=UTF-8
Content-Length: 41

{"eventId":"AAAABAAAAQDP3-jSlTMGVu0waj8"}

Using Event API

Event Creation API

URL: http://localhost:7070/events.json?accessKey=yourAccessKeyString

Query parameters:

The event creation support many commonly used data. POST request body:

Note About Properties

Note that properties can be:

1. Associated with an generic event: The properties field provide additional information about this event
2. Associated with an entity: The properties field is used to record the changes of an entity's properties with special events $set, $unset and $delete.

Please see the Events Modeling for detailed explanation.

Debugging Recipes

The accessKey query parameter is mandatory.

Replace <your_accessKey> and <your_eventId> by a real one in the following:

Get an Event

1

$ curl -i -X GET http://localhost:7070/events/<your_eventId>.json?accessKey=<your_accessKey>

Delete an Event

1

$ curl -i -X DELETE http://localhost:7070/events/<your_eventId>.json?accessKey=<your_accessKey>

Get Events of an App

1

$ curl -i -X GET http://localhost:7070/events.json?accessKey=<your_accessKey>

In addition, the following optional parameters are supported:

• startTime: time in ISO8601 format. Return events with eventTime >= startTime.
• untilTime: time in ISO8601 format. Return events with eventTime < untilTime.
• entityType: String. The entityType. Return events for this entityType only.
• entityId: String. The entityId. Return events for this entityId only.
• event: String. The event name. Return events with this name only.
• targetEntityType: String. The targetEntityType. Return events for this targetEntityType only.
• targetEntityId: String. The targetEntityId. Return events for this targetEntityId only.
• limit: Integer. The number of record events returned. Default is 20. -1 to get all.
• reversed: Boolean. Must be used with both entityType and entityId specified, returns events in reversed chronological order. Default is false.

For example, get all events of an app with eventTime >= startTime

1

$ curl -i -X GET "http://localhost:7070/events.json?accessKey=<your_accessKey>&startTime=<time in ISO8601 format>"

For example, get all events of an app with eventTime < untilTime:

1

$ curl -i -X GET "http://localhost:7070/events.json?accessKey=<your_accessKey>&untilTime=<time in ISO8601 format>"

For example, get all events of an app with eventTime >= startTime and eventTime < untilTime:

1

$ curl -i -X GET "http://localhost:7070/events.json?accessKey=<your_accessKey>&startTime=<time in ISO8601 format>&untilTime=<time in ISO8601 format>"

For example, get all events of a specific entity with eventTime < untilTime:

1

$ curl -i -X GET "http://localhost:7070/events.json?accessKey=<your_accessKey>&entityType=<your_entityType>&entityId=<your_entityId>&untilTime=<time in ISO801 format>"

Delete All Events of an App

Please use the following CLI command:

1

$ pio app data-delete <your_app_name>