Track event

POST 
/track/event

Track Event

This endpoint is used to track events and event properties from your backend.

Edit the Base URL in request schema for switching between regions.

Request Headers

• apikey: Your private API key (required for authorization)
• idempotent-key: Unique key to prevent duplicate processing. Required.
  • Minimum length: 5 characters
  • Maximum length: 36 characters
  • Valid for: 12 hours
  • Including the idempotent-key in headers ensures that even if the same request is sent multiple times, it will be processed only once within the validity period.

Request Body Fields

• ext_id (string): Your internal user ID performing the event
• name (string): Name of the event
• props_int (object): Integer-based properties (e.g., amount: 100)
• props_text (object): Text-based properties
• props_float (object): Float-based properties
• props_bool (object): Boolean flags
• occurred_at (string, ISO 8601): Timestamp of event occurrence

Sample Successful Response

{
	"rewards": [
		{
			"id": "d6de30f2-9429-492a-90ca-f68af2d96726",
			"uid": "f08ea141-e499-4790-8581-8dac9ceb8d10",
			"reward_qty": 1,
			"reward_id": "154d9166-cbdb-44f5-b9f4-a499482ae16a",
			"reward_name": "coin",
			"task_id": "a60e6b8e-d270-45ca-8f98-d57808afe607",
			"reward_type": 2,
			"coin_val": 1,
			"rwd_tid": null,
			"used_count": 0,
			"note": "",
			"status": 2,
			"updated_at": "2024-11-23T09:12:04.552Z",
			"created_at": "2024-11-23T09:12:05.418Z",
			"coupon_code": "",
			"expiry_at": null,
			"expiry_text": ""
		}
	]
}

Response Fields

Field	Type	Description
rewards	array	List of rewards associated with the tracked event
id	uuid	Reward transaction ID
uid	uuid	Unique identifier of the user who received the reward
reward_qty		Quantity of the reward
reward_id	uuid	Identifier of the reward
reward_name	string	Name of the reward (e.g. "coin")
task_id	uuid	Task ID associated with the reward
reward_type		Type of reward (enum)
coin_val		Coin value of the reward (if applicable)
used_count		Number of times the reward has been used
note	string	Notes or comments associated with the reward
status		Status of the reward (enum)
updated_at	string	Last updated timestamp in ISO 8601 format
created_at	string	Creation timestamp in ISO 8601 format
coupon_code	string	Coupon code (if applicable)
expiry_at	string	Expiry time of the reward (nullable)
expiry_text	string	Human-readable expiry information (optional)

Request

Responses

200

Successful response with rewards

204

Duplicate request (idempotent key reused within 12 hours)