Parameter | Type | Description | Request | Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | PUT | POST | DELETE | GET | PUT | POST | DELETE | |||||||
accountId | String | Unique identifier of your account | Yes | |||||||||||
memberId | String | A unique identifier of a member | Yes | Yes | ||||||||||
action | String | The identifier that describes the meaning of this event. For example; "win", "loose", "buy-in" etc. | Yes | Yes | ||||||||||
batchId | String | The batch identifier is used to group related event stream data together. Example; If you are using the global scoring strategy, that is to say events are sent omitting the competitionId and contestId then the activity reference identifier can be used to group related scoring events together. Using a simple mini game where the player starts a level and during the level has multiple events based on activity for example; collects three stars, jumps on a python and so on. Then all those events need to be grouped by that session for that player using a unique id. This could be as simple as a UUID or your internal reference to that distinct player session event | Optional | Yes | ||||||||||
entityId | String | It is a reference to a models ID for any of the following objects: | Yes | Yes | ||||||||||
sourceValue | Double | The actual numerical value related to the event. For example; this is the winnings, the rank achieved etc. | Yes | Yes | ||||||||||
points | Double | A value derived from the source value field. In the context of Product additionally an adjustment factor will be applied. | Yes | Yes | ||||||||||
transactionTimestamp | DateTime | ISO8601 timestamp. The time at which this event happened. | Yes | Yes | ||||||||||
relatesTo | Sequence [String] | Contains relatable object Id's of type of Competitions or Contests. | Yes | Yes | ||||||||||
relatesToExternal | Sequence [String] | Are meant to record extra information about the object that can be the original transaction Id or extra tagging information. | Yes | Yes | ||||||||||
Metadata | Object | A list of key value pairs | Yes | Yes | ||||||||||
key | String | Is a unique identifier | Yes | Yes | ||||||||||
value | Any | The data that is identified | Yes | Yes | ||||||||||
created | DateTime | ISO8601 timestamp for when an Event was created. All records are stored in UTC time zone. | Yes | |||||||||||
id | String | Unique CompetitionLabs identifier of an Event. | Yes |