Parameter

Type

Description















Request














Response
GETPUTPOSTDELETEGETPUTPOSTDELETE
accountId
StringUnique identifier of your account





Yes
memberId
StringA unique identifier of a member

Yes


Yes
action
StringThe 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
DoubleThe actual numerical value related to the event. For example; this is the winnings, the rank achieved etc.

Yes


Yes
points
DoubleA value derived from the source value field. In the context of Product additionally an adjustment factor will be applied.

Yes


Yes
transactionTimestamp
DateTimeISO8601 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
ObjectA list of key value pairs


Yes



Yes
     
keyStringIs a unique identifier

Yes


Yes
     
valueAnyThe data that is identified

Yes


Yes
created
DateTimeISO8601 timestamp for when an Event was created. All records are stored in UTC time zone.





Yes
id
StringUnique CompetitionLabs identifier of an Event.






Yes

</