Event
This API endpoint allows you to track and send your users' events on your platform to Referd.
Available Endpoints
The event APIs help you record any actions your user performs, along with any properties or metadata that describe the action. For further elaboration on events, check this article in our Help Center.
Each action is known as an event. Each event has a name, like place_order, and metadata, for example a place_order
event might have properties like amount
or source
. Calling events
is one of the first steps to getting started with Referd.
The event API call accepts a collection of event to help tracking multiple user actions. Event object is described below.
POST - Track Event
This API call is used to send an event to Referd where the received event will be evaluated.
Request
Header
APIKey
string
Yes
Client API key
Body
playerUniqueId
string
Yes
Unique identifier for the user at Referd
events
object
Yes
Collection of user events to be sent to Referd.
In case the user doesn't exist on Referd before sending the Event API call, the user will be created automatically on Referd.
event
Object
event
ObjectThe Event object is how you record any actions your users perform, along with any metadata that describes the action. For further elaboration on events check Understand your users' events.
Metadata are extra pieces of information you can tie to events you track. They can be none or anything that will be useful while analyzing the events later. We recommend sending properties whenever possible because they give you a more complete picture of what your users are doing. Every Metadata can be a number, a string or an array of values.
Event and Metadata example:
buy
product_id
"a123456"
price
30
product_category
"fashion"
product_tags
"men & new_collection"
Sample Event Object
Sample Request Body
Usage Examples
Example One
The below represents events done by a user with playerUniqueId
“player123” on two events:
Event “place_order”: (An event that has 2 metadata keys)
total_amount
: Total money paid by the playercategory
: Type of products being bought by player
Event
review
: (An event with no metadata)
Example Two
The below example shows how the event endpoint could be used to trigger an event to reserve 2 rooms:
Event
reserve
: An event with one metadata keyrooms
: Types of rooms booked by player, 1 for standard and 2 for deluxe rooms
Remarks
API consumer can provide any number of events given that each event name is not replicated
API consumer can provide from 0 to all event metadata keys, however the keys must not be replicated. If the consumer has multiple values for a single metadata key it should be provide as an array of strings as follows “key”: [“value1”, “value2”, “value3”, …]
Last updated