Analytics schema V4

Schema and Sample payloads for Analytics Events

Analytics are broadly classified into 4 types:

Page: Has context of the current page opened by the user. It can be a wallet, program, or any game.

Track: Has context of the user’s interaction, on the opened page. All interactions of users are grouped into track type.

State-Change: All state changes which happen on the server side are included in this category. Example: campaign completion, activity completion, etc.

System: Includes system level events like errors.

Page

{
   "event_name": "PAGE_OPENED",
   "type" : "page",
   "eventId" : "RGREFBupERuIh7m8XhN",
   "event_id": "RGREFBupERuIh7m8XhN",
   "user_id": "glu-test-user-dec-2-01",
   "userId": "glu-test-user-dec-2-01",
   "timestamp": "Mon, 05 Dec 2022 08:47:29 GMT",
   "session_id": "yQy7tsuA4hZ6mNCKYU",
   "session_time" : 5237,
   "referrer": "string",
   "analytics_version": "4.0.0",
   "page_details":{
      "page_layout": "FULL_PAGE",
      "page_name": "SPIN_THE_WHEEL_GAME_PAGE"
   },
   "campaign_details":{
      "campaign_id": "f0d2b40f-c69b-4851-ae2d-783f5c4aa850",
      "campaign_name": "Challenge",
      "campaign_experience": "SPIN_THE_WHEEL",
      "reward_user_id": "00fc6dbf-7d69-4435-99ff-34b3d6112dba",
      "campaign_state": "PRISTINE",
      "reward_status": "REDEEMABLE-SEEN",
      "selected_slot_index": 1,
      "reward_type": "CUSTOM_REWARD",
      "reward_title": "Discount 10%",
      "reward_amount": 100,
      "coupon_code": "TEST_COUPON_1"
   },
   "platform_details":{
      "device_type": "MOBILE", "WEB",
      "os": "CHROME", "SAFARI",
      "agent_type": "WEB_VIEW",
      "app_platform": "FLUTTER",
   },
   "optional_payload":{ "key1": "value1" }
}

FIELD	TYPE	DESCRIPTION	VALUES, (subject to change in case of updates)
event_name	string	PAGE_OPENED: When a page, sub-page, nudge page, or any custom page is opened	PAGE_OPENED
type	string	Type of event	page
event_id, eventId	string	Event Identification	unique string value
user_id, userId	string	User Identification.	respective user id received from client app
timestamp	string	ISO UTC timestamp of the event.	time at event fired
session_id	string	user session id	Any unique string value
session_time	number	time spent by the user till this event	in milliseconds
referrer	string	source of the redirection, it’s an OPTIONAL PROPERTY	optional property
analytics_version	string	analytic version used for the respective campaigns	Any string value with semantic versioning
page_details	object	represents the current page details
page_layout	string	represents the type layout used for this page.	FULL_PAGE, BOTTOM_SHEET, POPUP
page_name	string	name of the page opened. subject to change in case of different pages are added to the campaigns	Any string value including but not limited to, SPIN_THE_WHEEL_GAME_PAGE, SLOT_MACHINE_GAME_PAGE, TOSS_THE_COIN_GAME_PAGE, ROLL_THE_DICE_GAME_PAGE, GIFT_BOX_GAME_PAGE, CATCHING_GAME_PAGE, SCRATCH_CARD_GAME_PAGE, QUIZ_1_PAGE, INTRO_PAGE, DIRECT_REWARD_PAGE, PERSONALITY_QUIZ_PAGE, CG_WALLET_PAGE, MULTISTEP, STREAK, ACTIVITY_CHALLENGE, GAME_CHALLENGE, REFERRAL
campaign_details	object	It’s an optional property. Available only for campaign-level ui’s.	optional
campaign_name	string	name of the campaign opened by the user	Any string value
campaign_experience	string	type of the campaign	Any string value including but not limited to, SPIN_THE_WHEEL, SCRATCHCARD, DIRECT_REWARD, SLOTMACHINE, MEMORY_GAME, QUIZ, GIFT_BOX, SWIPE_UI, PERSONALITY_QUIZ, TOSS_THE_COIN, ROLL_THE_DICE, REFERRAL ,MULTI_STEP, STREAK, GAME_CHALLENGE
reward_user_id	string	unique reward id of the user for the particular campaign	Any string value
campaign_state	string	user’s campaign state for the opened campaign	PRISTINE, IN_PROGRESS, COMPLETED
reward_status	string	user’s reward state for the opened campaign	REDEEMABLE-SEEN, REDEEMABLE-UNSEEN
selected_slot_index	number	index of the slot selected based on the probability	Any number starting from 0
reward_type	string	type of reward	Any string value, including but not limited to: ["NO_REWARD", "CUSTOM_REWARD", "COUPONS", "COINS", "POINTS", "CASHBACKS", "DIRECT"]
reward_title	string	title of reward	Any string value
reward_amount	number	numeric component of the reward	Any number
coupon_code	string	Coupon code (if eligible)	Any string value
platform_details		user platform details
device_type	string	user device type	MOBILE, WEB
os	string	operating system of the user	CHROME, ANDROID, IOS, MICROSOFT
agent_type	string	user agent of the ui	WEB_VIEW, BROWSER, IFRAME
app_platform	string	user app type	FLUTTER, ANDROID, IOS, WEB
optional_payload	object	any custom properties can be added, for better analytics	key and value pairs

Track- Frontend

{
   "event_name": "COUPON_CODE_COPIED",
   "type":"track",
   "eventId" : "EbZ1coFBupERuIh7m8XhN",
   "event_id": "EbZ1coFBupERuIh7m8XhN",
   "user_id": "glu-test-user-dec-2-01",
   "userId": "glu-test-user-dec-2-01",
   "timestamp": "Mon, 05 Dec 2022 08:47:29 GMT",
   "session_id": "ROyQy7tsuA4hZ6mNCKYU",
   "session_time": 5237,
   "referrer": "string",
   "analytics_version": "4.0.0",
   "page_details":{
      "page_layout": "FULL_PAGE",
      "page_name": "SPIN_THE_WHEEL_GAME_PAGE
   },
   "campaign_details":{
      "campaign_id": "f0d2b40f-c69b-4851-ae2d-783f5c4aa850",
      "campaign_name": "Challenge",
      "campaign_experience": "SPIN_THE_WHEEL",
      "reward_user_id": "00fc6dbf-7d69-4435-99ff-34b3d6112dba",
      "campaign_state": "PRISTINE",
      "reward_status": "REDEEMABLE-SEEN",
      "selected_slot_index": 1,
      "reward_type": "CUSTOM_REWARD",
      "reward_title": "Discount 10%",
      "reward_amount": 100,
      "coupon_code": "TEST_COUPON_1"
   },
   "platform_details":{
      "device_type": "MOBILE",
      "os": "CHROME",
      "agent_type": "WEB_VIEW",
      "app_platform": "FLUTTER"
   },
   "interaction_details": {
      "button_name": "string",
      "properties": {
         "code": "CODE_123",
         "deep_link": "xyz/wallet/purchase",
	 "web_link": "https://xyz.com/test",
         "channel": "string"
      },
      "quiz_details":{
      	 "session_id": "jbkj77",
         "question_index": 1,
         "correct_answer": "answer 2",
         "user_answer": "answer 2" ,
         "is_correct": false
      },
   "survey_details":{
      "survey_page_index":1
      "all_fields":[
      {
	"field_type":"text_box",
	"survey_question_index":1,
	"question":"string",
	"user_answers":["string"],
      },
      {
	"field_type":"DOB",
	"survey_question_index":"number",
	"question":"string",
	"user_answers":["string"],
      },
      {
	"field_type":"check_box",
	"survey_question_index":2,
	"question":"string",
	"user_answers":["string"],
      },
      {
	"field_type":"drop_down",
	"survey_question_index":3,
	"question":"string",
	"user_answers":["string"],
      },
      {
	"field_type":"ratings",
	"survey_question_index":4,
	"question":"string",
	"user_answers":["string"],
      }
   ]
},
"optional_payload":{"keys": "values"},
}

FIELD	TYPE	DESCRIPTION	VALUES, (subject to change in case of updates)
event_name	string	user interaction event on the UI	Any string value including but not limited to: "COUPON_CODE_COPIED" "REWARD_CLAIMED" "TRY_AGAIN_CLICKED" "CAMPAIGN_BANNER_CLICKED" "REFERRAL_LINK_COPIED" "REFERRAL_CODE_COPIED" "REWARD_CARD_CLICKED" "VIEW_REWARD_CLICKED" "QUIZ_QUESTION_SKIPPED" "QUIZ_QUESTION_ANSWERED" "CAMPAIGN_PLAY" "BACK_BUTTON_CLICKED" "BUTTON_CLICKED" "VIEW_ALL" "REMIND_CLICKED" "CLOSE" "GAME_PLAYED" "ACTIVITY_CLICKED" "CLOSE_CLICKED" "SURVEY_ANSWERED" "TIME_OVER"
type	string	Type of event	track
event_id, eventId	string	Event Identification	unique string value
user_id, userId	string	User Identification.	respective user id received from client app
timestamp	string	ISO UTC timestamp of the event.	time at which event triggered
session_id	string	user session id	Any unique string value
session_time	number	time spent by the user till this event	in milliseconds
referrer	string	source of the redirection	Any string value
analytics_version	string	analytic version used for the respective campaigns	Any string value with semantic versioning
page_details	object	represents the current page details
page_layout	string	represents the type layout used for this page.	FULL_PAGE, BOTTOM_SHEET, POPUP
page_name	string	name of the page opened. subject to change in case of different pages are added to the campaigns	Any string value including but not limited to, SPIN_THE_WHEEL_GAME_PAGE, SLOT_MACHINE_GAME_PAGE, TOSS_THE_COIN_GAME_PAGE, ROLL_THE_DICE_GAME_PAGE, GIFT_BOX_GAME_PAGE, CATCHING_GAME_PAGE, SCRATCH_CARD_GAME_PAGE, QUIZ_1_PAGE, INTRO_PAGE, DIRECT_REWARD_PAGE, PERSONALITY_QUIZ_PAGE, CG_WALLET_PAGE, MULTISTEP, STREAK, ACTIVITY_CHALLENGE, GAME_CHALLENGE, REFERRAL
campaign_details	object	It’s an optional property. Available only for campaign-level interactions.	optional
campaign_name	string	name of the campaign opened by the user	Any string value
campaign_experience	string	type of the campaign	Any string value including but not limited to, SPIN_THE_WHEEL, SCRATCHCARD, DIRECT_REWARD, SLOTMACHINE, MEMORY_GAME, QUIZ, GIFT_BOX, SWIPE_UI, PERSONALITY_QUIZ, TOSS_THE_COIN, ROLL_THE_DICE, REFERRAL ,MULTI_STEP, STREAK, GAME_CHALLENGE
reward_user_id	string	unique reward id of the user for the particular campaign	Any string value
campaign_state	string	user’s campaign state for the opened campaign	PRISTINE, IN_PROGRESS, COMPLETED
reward_status	string	user’s reward state for the opened campaign	REDEEMABLE-SEEN, REDEEMABLE-UNSEEN
selected_slot_index	number	Selected slot index based on the probability	Any number starting from 0
reward_type	string	Type of the reward	Any string value, including but not limited to: ["NO_REWARD", "CUSTOM_REWARD", "COUPONS", "COINS", "POINTS", "CASHBACKS", "DIRECT"]
reward_title	string	Title of the reward	Any string value
reward_amount	number	Numeric component of the reward	Any number
coupon_code	string	Coupon code (if eligible)	Any string value
platform_details	object	user platform details
device_type	string	user device type	MOBILE, WEB
os	string	the operating system of the user	CHROME, ANDROID, IOS, MICROSOFT
agent_type	string	user agent of the ui	WEB_VIEW, BROWSER, IFRAME
app_platform	string	user app type	FLUTTER, ANDROID, IOS, WEB
optional_payload	object	any custom properties can be added, for better analytics	It’s an optional payload
interaction_details	object	user interaction (click) details	It’s an optional object, sub-properties depend on the event_name
button_name	string	button name of this click event	name of the button
code	string	code copied by user	Any string value
deep_link	string	deeplink opened by user	Any string value
web_link	string	web link opened by user	Any string value
channel	string	share channel	WHATSAPP, etc
session_id	string	unique quiz session id	Any string value
question_index	number	question id of the current user	number
user_answer	string	user answer for the question	Any string value
user_answers	array	in case of multiple answers (surveys)	Array of strings
correct_answer	string	correct answer for the question	Any string value
is_correct	boolean	user answer state	true, false
survey_page_index	number	current survey page id	number
field_type	string	current question type	TEXT_INPUT, CHECK_BOX, DROP_DOWN, RATINGS
survey_question_index	number	current survey question id	number
question	string	survey question	Any string value

Track-SDK

Webview Load

{
  "analytics_version":"4.1.0",
  "type":"track",
  "event_name":"WEBVIEW_LOAD",
  "event_id":"018a34b1-71bb-4022-b410-cd0b015f136d",
  "user_id":"string",
  "timestamp":"2022-09-05T07:27:25.852Z",
  "webview_content":{
    "webview_url":"xyz.com",
    "webview_layout":"FULLSCREEN",
    "absolute_height":"",
    "relative_height":""
  },
  "platform_details":{
    "device_type":"MOBILE",
    "os":"CHROME",
    "app_platform":"FLUTTER",
    "sdk_version":"v1.0.9"
  }
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	WEBVIEW_LOAD
type	string	event type	track
event_id	string	Unique event Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	"4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
device_type	string	Mobile or Web as the device type	"MOBILE", "WEB"
os	string	Client platform where the SDK is consumer	"CHROME", "SAFARI", "MOZILLA", "ANDROID", "IOS"
app_platform	string	SDK development platform / framework / plugin used	"FLUTTER", "ANDROID", "REACT_NATIVE", "IOS", "WEB"
sdk_version	string	SDK version	Any String Value
webview_url	string	The website url which is loaded in the webview	Any String Value
webview_layout	string	The webview layout configuration	middle-default
absolute_height	string	Webview’s absolute height	Any String Value (Numbers Only)
relative_height	string	Webview's height in percentage	Any String Value (Numbers Only between 1- 100)

Webview Dismiss

{
  "analytics_version":"4.1.0",
  "event_name":"WEBVIEW_DISMISS",
  "type":"track",
  "event_id":"018a34b1-71bb-4022-b410-cd0b015f136d",
  "user_id":"string",
  "timestamp":"2022-09-05T07:27:25.852Z",
  "dismiss_trigger":"PHYSICAL_BUTTON",
  "webview_content":{
    "webview_url":"xyz.com",
    "webview_layout":"FULLSCREEN",
    "absolute_height":"",
    "relative_height":""
  },
  "platform_details":{
    "device_type":"MOBILE",
    "os":"CHROME",
    "app_platform":"FLUTTER",
    "sdk_version":"v1.0.9"
  }
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	WEBVIEW_DISMISS
type	string	Event type	track
event_id	string	Unique event Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	"4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
device_type	string	Mobile or Web as the device type	"MOBILE", "WEB"
os	string	Client platform where the SDK is consumer	"CHROME", "SAFARI", "MOZILLA", "ANDROID", "IOS"
app_platform	string	SDK development platform / framework / plugin used	"FLUTTER", "ANDROID", "REACT_NATIVE", "IOS", "WEB"
sdk_version	string	SDK version	Any String Value
dismiss_trigger	sting	Dismiss Mechanism for the Nudge	PHYSICAL_BUTTON
webview_url	string	The website url which is loaded in the webview	Any String Value
webview_layout	string	The webview layout configuration	middle-default
absolute_height	string	Webview’s absolute height	Any String Value (Numbers Only)
relative_height	string	Webview's height in percentage	Any String Value (Numbers Only between 1- 100)

Notification Load (only triggered if the app is in foreground)

{
  "analytics_version":"4.1.0",
  "event_name":"NOTIFICATION_LOAD",
  "type":"track",
  "event_id":"018a34b1-71bb-4022-b410-cd0b015f136d",
  "user_id":"string",
  "timestamp":"2022-09-05T07:27:25.852Z",
  "platform_details":{
    "device_type":"MOBILE",
    "os":"CHROME",
    "app_platform":"FLUTTER",
    "sdk_version":"v1.0.9"
  },
  "nudge":{
    "nudge_id":"",
    "type":"push",
    "campaign_id":"",
    "title":"",
    "body":"",
    "nudge_layout":"",
    "click_action":""
  }
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	NOTIFICATION_LOAD
type	string	Event type	track
event_id	string	Unique event Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	"4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
device_type	string	Mobile or Web as the device type	"MOBILE", "WEB"
os	string	Client platform where the SDK is consumer	"CHROME", "SAFARI", "MOZILLA", "ANDROID", "IOS"
app_platform	string	SDK development platform / framework / plugin used	"FLUTTER", "ANDROID", "REACT_NATIVE", "IOS", "WEB"
sdk_version	string	SDK version	Any String Value
nudge_id	string	Unique nudge identifier	Any String Value
type	string	Nudge type constant	push
campaign_id	string	Unique Campaign identifier (optional)	Any String Value
title	string	Nudge Notification Title	Any String Value
body	string	Nudge Notification Body	Any String Value
click_action	string	Nudge Notification Load URL	Any String Value
nudge_layout	string	Represent nudge open layout	middle-default

Push Notification Clicked

{
  "event_name":"PUSH_NOTIFICATION_CLICK",
  "type":"track",
  "event_id":"018a34b1-71bb-4022-b410-cd0b015f136d",
  "user_id":"string",
  "timestamp":"2022-09-05T07:27:25.852Z",
  "platform_details":{
    "device_type":"MOBILE",
    "os":"IOS",
    "app_platform":"FLUTTER",
    "sdk_version":"v1.0.9"
  },
  "nudge":{
    "nudge_id":"",
    "type":"push",
    "campaign_id":"",
    "title":"",
    "body":"",
    "click_action":""
  }
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	PUSH_NOTIFICATION_CLICK
type	string	Event type	track
event_id	string	Unique event Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	"4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
device_type	string	Mobile or Web as the device type	"MOBILE", "WEB"
os	string	Client platform where the SDK is consumer	"CHROME", "SAFARI", "MOZILLA", "ANDROID", "IOS"
app_platform	string	SDK development platform / framework / plugin used	"FLUTTER", "ANDROID", "REACT_NATIVE", "IOS", "WEB"
sdk_version	string	SDK version	Any String Value
nudge_id	string	Unique nudge identifier	Any String Value
type	string	Nudge type constant	push
campaign_id	string	Unique Campaign identifier	Any String Value
title	string	Nudge Notification Title	Any String Value
body	string	Nudge Notification Body	Any String Value
click_action	string	Nudge Notification Load URL	Any String Value

Entry Point Load

{
  "analytics_version":"4.1.0",
  "type":"track",
  "timestamp":"2022-09-05T07:27:25.852Z",
  "event_id":"018a34b1-71bb-4022-b410-cd0b015f136d",
  "user_id":"string",
  "event_name":"ENTRY_POINT_LOAD",
  "platform_details":{
    "device_type":"MOBILE",
    "os":"CHROME",
    "app_platform":"FLUTTER",
    "sdk_version":"v1.0.9"
  },
  "entry_point_data":{
    "entry_point_id":"string",
    "entry_point_name":"string",
    "entry_point_location":"string",
    "entry_point_content":{
      "type":"WALLET",
      "campaign_id":"string",
      "static_url":"string"
    },
    "entry_point_container":"POP_UP"
  }
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	ENTRY_POINT_LOAD
type	string	Event type	track
event_id	string	Unique event Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	"4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
device_type	string	Mobile or Web as the device type	"MOBILE", "WEB"
"WEB”
os	string	Client platform where the SDK is consumer	"CHROME", "SAFARI", "MOZILLA", "ANDROID", "IOS”"CHROME", "SAFARI", "MOZILLA", "ANDROID", "IOS”"CHROME", "SAFARI", "MOZILLA", "ANDROID", "IOS”"CHROME", "SAFARI", "MOZILLA", "ANDROID", "IOS”
app_platform	string	SDK development platform / framework / plugin used	"FLUTTER", "ANDROID", "REACT_NATIVE", "IOS", "WEB"
sdk_version	string	SDK version	Any String Value
campaign_id	string	Unique Campaign identifier	Any String Value
entry_point_id	string	Entry point unique identifier	Any String Value
entry_point_name	string	Entry point unique name	Any String Value
entry_point_location	string	Entry point location screen name	Any String Value (Screen Name)
type	string	The type of campaign / URL the entry point is opening.	"WALLET","CAMPAIGN","STATIC"
static_url	string	The 3rd party URL which is loaded in the webview (Incase of campaignId being missing this URL is loaded)	Any String Value (URL)
entry_point_container	string	The type of entry point.	"POP_UP","BOTTOM_SHEET","ICON_BUTTON","CHAT_BOX","FLOATING","EMBED","BANNER"

ENTRY POINT CLICK

{
  "analytics_version":"4.1.0",
  "type":"track",
  "timestamp":"2022-09-05T07:27:25.852Z",
  "event_name":"ENTRY_POINT_CLICK",
  "event_id":"018a34b1-71bb-4022-b410-cd0b015f136d",
  "user_id":"string;",
  "platform_details":{
    "device_type":"MOBILE",
    "os":"CHROME",
    "app_platform":"FLUTTER",
    "sdk_version":"v1.0.9"
  },
  "entry_point_data":{
    "entry_point_id":"string",
    "entry_point_name":"string",
    "entry_point_location":"string",
    "entry_point_action":{
      "action_type":"open",
      "open_container":"FULLSCREEN",
      "open_content":{
        "type":"WALLET",
        "campaign_id":"string",
        "static_url":"string"
      }
    },
    "entry_point_content":{
      "type":"WALLET",
      "campaign_id":"string",
      "static_url":"string"
    },
    "entry_point_container":"POP_UP"
  }
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	ENTRY_POINT_CLICK
type	string	Event type	track
event_id	string	Unique event Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	"4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
device_type	string	Mobile or Web as the device type	"MOBILE", "WEB"
"WEB”
os	string	Client platform where the SDK is consumer	"CHROME", "SAFARI", "MOZILLA", "ANDROID", "IOS”
app_platform	string	SDK development platform / framework / plugin used	"FLUTTER", "ANDROID", "REACT_NATIVE", "IOS", "WEB"
sdk_version	string	SDK version	Any String Value
campaign_id	string	Unique Campaign identifier	Any String Value
entry_point_id	string	Entry point unique identifier	Any String Value
entry_point_name	string	Entry point unique name	Any String Value
entry_point_location	string	Entry point location screen name	Any String Value (Screen Name)
action_type	string	Entry point action type	OPEN
open_container	string	Entry point container type	middle-default
type	string	The type of campaign / URL the entry point is opening.	"WALLET","CAMPAIGN","STATIC"
static_url	string	The 3rd party URL which is loaded in the webview (Incase of campaignId being missing this URL is loaded)	Any String Value (URL)
entry_point_container	string	The type of entry point.	"POP_UP","BOTTOM_SHEET","ICON_BUTTON","CHAT_BOX","FLOATING","EMBED","BANNER"

ENTRY POINT DISMISS

{
  "analytics_version":"4.1.0",
  "type":"track",
  "event_name":"ENTRY_POINT_DISMISS",
  "event_id":"018a34b1-71bb-4022-b410-cd0b015f136d",
  "user_id":"string",
  "timestamp":"2022-09-05T07:27:25.852Z",
  "entry_point_data":{
    "entry_point_id":"string",
    "entry_point_name":"string",
    "entry_point_location":"string"
  },
  "platform_details":{
    "device_type":"MOBILE",
    "os":"CHROME",
    "app_platform":"FLUTTER",
    "sdk_version":"v1.0.9"
  }
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	ENTRY_POINT_DISMISS
type	string	Event type	track
event_id	string	Unique event Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	"4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
device_type	string	Mobile or Web as the device type	"MOBILE", "WEB"
"WEB”
os	string	Client platform where the SDK is consumer	"CHROME", "SAFARI", "MOZILLA", "ANDROID", "IOS”
app_platform	string	SDK development platform / framework / plugin used	"FLUTTER", "ANDROID", "REACT_NATIVE", "IOS", "WEB"
sdk_version	string	SDK version	Any String Value
entry_point_id	string	Entry point unique identifier	Any String Value
entry_point_name	string	Entry point unique name	Any String Value
entry_point_location	string	Entry point location screen name	Any String Value (Screen Name)

State-Change

Campaign Completed

It's triggered when a campaign is completed

• For Games, it gets triggered on winning a reward

• For Challenges, it gets triggered on completing all activities

{
  "event_name":"CAMPAIGN_COMPLETED",
  "type":"state-change",
  "event_id":"018a34b1-71bb-4022-b410-cd0b015f136d",
  "client":"c6a4681d-5599-4ba3-bb7c-2XXXXXb",
  "user_id":"glutest-realUser",
  "analytics_version":"4.0.0",
  "timestamp":"2022-09-05T07:27:25.852Z",
  "campaign_details":{
      "campaign_id":"6b81a527-fd14-48b9-932a-6d3c1bc9f2XX",
      "campaign_name":"Campaign name configured by the client",
      "campaign_experience":"MEMORYGAME",
      "campaign_state":"COMPLETED"
    },
  "reward_details":{
      "reward_index":1,
      "reward_id":"d0f8942b-df4b-4c86-985e-fe13b61f117f",
      "reward_status":"REDEEMABLE-SEEN",
      "reward_title":"Congrats you've won 100 INR Cashback",
      "reward_type":"CUSTOMREWARD",
      "reward_amount":20
    }
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	CAMPAIGN_COMPLETED
type	string	Event type	state-change
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	"4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_name	string	Name of the campaign	Any String Value
campaign_experience	string	Experience of campaign	Any String value Including but not limited to "MEMORYGAME" ,"QUIZ" , "SPINTHEWHEEL" , "SCRATCHCARD" , "SLOTMACHINE" , "GIFTBOX" , "ROLLTHEDICE" , "SWIPEUI" , "TOSSTHECOIN", “UNITYGAME”, ”SURVEY”
campaign_state	string(enum)	User’s state in campaign lifecycle	“COMPLETED”
reward_index	Number	Index of reward won by user	Any numerical value.
reward_id	string	Unique value for each generated reward	Any string value
reward_status	string(enum)	Reward’s state	"REDEEMABLE-SEEN"
reward_title	string	Reward title added by you for the campaign	Any string value
reward_type	string(enum)	Reward type added by you for the campaign	Any String value Including but not limited to "CUSTOMREWARD", "COUPONS" , "COINS" , "POINTS" ,"CASHBACKS","NOREWARD"
reward_amount	Number/null	Reward amount added by you	Any numerical value or null

Challenge Accepted

Triggered when the user opts in to become a part of the challenge (explicit acceptance as a pre-requisite is configurable via the dashboard)

{
    "event_id": "40278234-5bd5-4dfd-bcb4-d6a834b25d44",
    "client": "84acf2ac-b2e0-4927-8653-cba2b83816c2",
    "user_id": "glutest-21-oct-134",
    "analytics_version": "4.0.0",
    "type":"state-change",
    "timestamp": "2022-11-25T07:11:51Z",
    "campaign_details": {
        "campaign_id": "1593c385-e3cf-45ad-ad89-fb57732b6903",
        "campaign_name": "multistep",
        "campaign_experience": "MULTISTEP",
        "campaign_status": "PRISTINE",
        "campaign_steps_completed": 0,
        "campaign_total_steps": 1,
        "campaign_expires_on": "2022-11-26T18:29:59Z",
        "campaign_expiry_type": "RELATIVE",
        "campaign_expired": false
    },
    "event_name": "CHALLENGE_ACCEPTED"
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	CHALLENGE_ACCEPTED
type	string	Event type	state-change
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	Any String value Including but not limited to "4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_name	string	Name of the campaign	Any String Value
campaign_experience	string	Experience of campaign	Any String value Including but not limited to "SPINTHEWHEEL","SLOTMACHINE","SCRATCHCARD","DIRECT","MEMORYGAME","QUIZ","REFERRAL","MULTISTEP","STREAK","ACTIVITY-SCRATCHCARD","COLLECTTHESTAMPS","GAMECHALLENGE","UNITY","TOSSTHECOIN","ROLLTHEDICE","UNITYGAME","GIFTBOX","SURVEY",
campaign_status	string	User’s state in campaign lifecycle	Any String value (Including but not limited to 'PRISTINE', 'IN-PROGRESS', 'COMPLETED', 'EXPIRED’ )
campaign_steps_completed	number	Number of steps completed by user in campaign lifecycle	Positive numerical value
campaign_total_steps	number	Total number of steps available in campaign lifecycle	Positive numerical value
campaign_expires_on	string	UTC timestamp	Any String Value
campaign_expiry_type	string(enum)	Type of expiration	'ABSOLUTE', 'RELATIVE', 'NEVER’
campaign_expired	boolean	flag whether campaign is expired or not	true,false

Reward Granted

Triggered when the user sees a reward.

{
    "event_id": "d0828fa1-3978-4aa1-8032-7b39be6f6829",
    "type":"state-change",
    "client": "84acf2ac-b2e0-4927-8653-cba2b83816c2",
    "user_id": "glutest-21-oct-32",
    "analytics_version": "4.0.0",
    "timestamp": "2022-11-30T06:33:48Z",
    "campaign_details": {
            "campaign_id": "1593c385-e3cf-45ad-ad89-fb57732b6903",
            "campaign_name": "multistep",
            "campaign_experience": "MULTISTEP",
            "campaign_status": "IN-PROGRESS"
    },
    "reward_details": {
        "reward_coupon_code": null,
        "reward_index": 0,
        "reward_id": "e446226d-b380-4915-917d-e09c74c353e6",
        "reward_status": "REDEEMABLE-SEEN",
        "reward_title": "Unlimited free courses",
        "reward_body": "Woohoo! You've won unlimited free courses on completing the SkillUp Get Started Challenge.",
        "reward_type": "CUSTOMREWARD",
        "reward_amount": null
    },
    "event_name": "REWARD_GRANTED"
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	REWARD_GRANTED
type	string	Event type	state-change
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	Any String value Including but not limited to "4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_name	string	Name of the campaign	Any String Value
campaign_experience	string	Experience of campaign	Any String value Including but not limited to "SPINTHEWHEEL","SLOTMACHINE","SCRATCHCARD","DIRECT","MEMORYGAME","QUIZ","REFERRAL","MULTISTEP","STREAK","ACTIVITY-SCRATCHCARD","COLLECTTHESTAMPS","GAMECHALLENGE","UNITY","TOSSTHECOIN","ROLLTHEDICE","UNITYGAME","GIFTBOX","SURVEY",
campaign_status	string	User’s state in campaign lifecycle	Any String value (Including but not limited to 'PRISTINE', 'IN-PROGRESS', 'COMPLETED', 'EXPIRED’ )
reward_coupon_code	string/null	Reward coupon allotted to user	Any String value
reward_index	Number	Index of reward won by user	Any numerical value.
reward_id	string	Unique value for each generated reward	Any string value
reward_status	string(enum)	Reward’s state	"REDEEMABLE-SEEN"
reward_title	string	Reward title added by you for the campaign	Any string value
reward_body	string	Reward body added by you for the campaign	Any string value
reward_type	string(enum)	Reward type added by you for the campaign	Any String value Including but not limited to "CUSTOMREWARD","COUPONS" ,"COINS","POINTS","CASHBACKS","NOREWARD"
reward_amount	Number/null	Reward amount added by you	Any numerical value or null

Reward Created

Triggered when the system creates a reward.

{
    "event_id": "4f8fb4a2-d68c-482a-bd6c-e45f6ffae776",
    "type":"state-change",
    "client": "84acf2ac-b2e0-4927-8653-cba2b83816c2",
    "user_id": "glutest-21-oct-32",
    "analytics_version": "4.0.0",
    "timestamp": "2022-11-30T06:33:08Z",
    "campaign_details": {
            "campaign_id": "1593c385-e3cf-45ad-ad89-fb57732b6903",
            "campaign_name": "multistep",
            "campaign_experience": "MULTISTEP",
            "campaign_status": "IN-PROGRESS"
        
    },
    "reward_details": {
        "reward_coupon_code": null,
        "reward_index": 0,
        "reward_id": "e446226d-b380-4915-917d-e09c74c353e6",
        "reward_status": "REDEEMABLE-UNSEEN",
        "reward_title": "Unlimited free courses",
        "reward_body": "Woohoo! You've won unlimited free courses on completing the SkillUp Get Started Challenge.",
        "reward_type": "CUSTOMREWARD",
        "reward_amount": null
    },
    "event_name": "REWARD_CREATED"
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	REWARD_CREATED
type	string	Event type	state-change
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	Any String value Including but not limited to "4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_name	string	Name of the campaign	Any String Value
campaign_experience	string	Experience of campaign	Any String value Including but not limited to "SPINTHEWHEEL","SLOTMACHINE","SCRATCHCARD","DIRECT","MEMORYGAME","QUIZ","REFERRAL","MULTISTEP","STREAK","ACTIVITY-SCRATCHCARD","COLLECTTHESTAMPS","GAMECHALLENGE","UNITY","TOSSTHECOIN","ROLLTHEDICE","UNITYGAME","GIFTBOX","SURVEY",
campaign_status	string	User’s state in campaign lifecycle	Any String value (Including but not limited to 'PRISTINE', 'IN-PROGRESS', 'COMPLETED', 'EXPIRED’ )
reward_coupon_code	string/null	Reward coupon allotted to user	Any String value
reward_index	Number	Index of reward won by user	Any numerical value.
reward_id	string	Unique value for each generated reward	Any string value
reward_status	string(enum)	Reward’s state	"REDEEMABLE-UNSEEN","REDEEMABLE-SEEN"
reward_title	string	Reward title added by you for the campaign	Any string value
reward_body	string	Reward body added by you for the campaign	Any string value
reward_type	string(enum)	Reward type added by you for the campaign	Any String value Including but not limited to "CUSTOMREWARD","COUPONS" ,"COINS","POINTS","CASHBACKS" ,"NOREWARD"
reward_amount	Number/null	Reward amount added by you	Any numerical value or null

Campaign Expiry Reminder

Triggered 24 hours before expiry of a campaign (trigger time is configurable with default value being 24 hours)

{
  "analytics_version": "4.0.0",
  "campaign_details": {
    "campaign_experience": "multistep",
    "campaign_expiration_type": "RELATIVE",
    "campaign_expired": false,
    "campaign_expiring_in_hours": 24,
    "campaign_expiry": "2023-05-30T17:55:08.000Z",
    "campaign_id": "d2458db9-9e40-492c-aa26-dcea83d59782",
    "campaign_name": "untitled multi step",
    "campaign_state": "running"
  },
  "client": "0f922980-2d6e-4bb8-ae9a-0b268223b98b",
  "event_id": "29c3088d-5521-4701-86a7-f14a22597aac",
  "event_name": "EXPIRY_REMINDER",
  "timestamp": "2023-05-29T17:51:47.262Z",
	"user_id":" testUserId"
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	EXPIRY_REMINDER
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	Any String value Including but not limited to "4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_expiry	string	UTC timestamp of the expiry	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_name	string	Name of the campaign	Any String Value
campaign_expiration_type	string(enum)	Type of expiration	"RELATIVE" ,"ABSOLUTE"
campaign_expired	boolean	flag whether campaign is expired or not	Boolean values (true, false)
campaign_experience	string	Experience of campaign	Any String value Including but not limited to "MULTISTEP", "STREAK", "GAMECHALLENGE",
campaign_expiring_in_hours	int	Duration in which the campaign is going to be expired	Any Integer value denoting the duration in hours in which the campaign is going to be expired
campaign_state	string	Status of the campaign	RUNNING, STOPPED

Campaign Expired

Triggered when a campaign’s program expiry (absolute/relative) is completed.

{
  "event_name":"CAMPAIGN_EXPIRED",
  "type":"state-change",
  "event_id":"018a34b1-71bb-4022-b410-cd0b015f136d",
  "client":"c6a4681d-5599-4ba3-bb7c-2XXXXXb",
  "user_id":"glutest-realUser",
  "analytics_version":"4.0.0",
  "timestamp":"2022-09-05T07:27:25.852Z",
  "campaign_details":{
    "campaign_expiry":"2022-09-05T07:27:25.852Z",
    "campaign_id":"6b81a527-fd14-48b9-932a-6d3c1bc9f2XX",
    "campaign_name":"Campaign name configured by the client",
    "campaign_expiration_type":"RELATIVE",
    "campaign_expired":true,
    "campaign_experience":"MEMORYGAME",
    "campaign_state":"STOPPED"
  }
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	CAMPAIGN_EXPIRED
type	string	Event type	state-change
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	Any String value Including but not limited to "4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_expiry	string	UTC timestamp of the expiry	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_name	string	Name of the campaign	Any String Value
campaign_expiration_type	string(enum)	Type of expiration	"RELATIVE" ,"ABSOLUTE"
campaign_expired	boolean	flag whether campaign is expired or not	Boolean values (true, false)
campaign_experience	string	Experience of campaign	Any String value Including but not limited to "MULTISTEP","STREAK","GAMECHALLENGE",
campaign_state	string	Status of the campaign	RUNNING, STOPPED

Multistep/Streak User Joined

Triggered when a user joins a multistep, streak, campaign.

{
    "event_id": "131d20ca-3b65-46dd-ab7f-2c72562283eb",
    "type":"state-change",
    "client": "84acf2ac-b2e0-4927-8653-cba2b83816c2",
    "user_id": "glutest-21-oct-134",
    "analytics_version": "4.0.0",
    "timestamp": "2022-11-25T07:11:42Z",
    "campaign_details": {
            "campaign_id": "072ab872-4407-4d19-aea9-c8d977c8cf93",
            "campaign_name": "streak is running",
            "campaign_experience": "STREAK",
            "campaign_status": "PRISTINE",
            "campaign_steps_completed": 0,
            "campaign_total_steps": 5,
            "campaign_expires_on": "2022-12-05T18:29:59Z",
            "campaign_expiry_type": "RELATIVE",
            "campaign_expired": false
        }
    },
    "event_name": "CAMPAIGN_JOINED"
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	CAMPAIGN_JOINED
type	string	Event type	state-change
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	Any String value Including but not limited to "4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_name	string	Name of the campaign	Any String Value
campaign_experience	string	Experience of campaign	"MULTISTEP","STREAK"
campaign_status	string	User’s state in campaign lifecycle	User’s state in campaign lifecycle Any String value (Including but not limited to 'PRISTINE' )
campaign_steps_completed	Number	Number of steps completed by user in campaign lifecycle	Positive numerical value
campaign_total_steps	Number	Total number of steps available in campaign lifecycle	Positive numerical value
campaign_expires_on	string	UTC timestamp	Any String Value
campaign_expiry_type	string(enum)	Type of expiration	'ABSOLUTE', 'RELATIVE', 'NEVER’
campaign_expired	boolean	flag whether campaign is expired or not	true,false

MultiStep Activity completed

Triggered when a user completes an activity in a multistep campaign

{
    "event_id": "94dc43bc-9f3f-43a1-93a2-455690777efc",
    "type":"state-change",
    "client": "84acf2ac-b2e0-4927-8653-cba2b83816c2",
    "user_id": "glutest-21-oct-134",
    "analytics_version": "4.0.0",
    "timestamp": "2022-11-25T07:12:11Z",
    "campaign_details": {
            "campaign_id": "1593c385-e3cf-45ad-ad89-fb57732b6903",
            "campaign_name": "multistep",
            "campaign_experience": "MULTISTEP",
            "campaign_status": "IN-PROGRESS",
            "campaign_steps_completed": 0,
            "campaign_total_steps": 1,
            "campaign_expires_on": "2022-11-26T18:29:59Z",
            "campaign_expiry_type": "RELATIVE",
            "campaign_expired": false,
            "campaign_activity": {
            "activity_completed_total": 1,
            "activity_completed_daily": 1,
            "activity_limits_total": 4,
            "activity_limits_daily": 4,
            "campaign_activity_status": "IN-PROGRESS",
            "campaign_activity_id": "d7fa0ffe-e415-472d-86e0-388b754050a2",
            "campaign_activity_event_name": "Update Learning Progress",
            "campaign_activity_completed_on": "2022-11-25T07:12:11Z"
            }
    },
    "event_name": "MULTISTEP_ACTIVITY_COMPLETED"
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	MULTISTEP_ACTIVITY_COMPLETED
type	string	Event type	state-change
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	Any String value Including but not limited to "4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_name	string	Name of the campaign	Any String Value
campaign_experience	string	Experience of campaign	"MULTISTEP"
campaign_status	string	User’s state in campaign lifecycle	Any String value (Including but not limited to , 'IN-PROGRESS', 'COMPLETED', 'EXPIRED’ )
campaign_steps_completed	Number	Number of steps completed by user in campaign lifecycle	Positive numerical value
campaign_total_steps	Number	Total number of steps available in campaign lifecycle	Positive numerical value
campaign_expires_on	string	UTC timestamp	Any String Value
campaign_expiry_type	string(enum)	Type of expiration	'ABSOLUTE', 'RELATIVE', 'NEVER’
campaign_expired	boolean	flag whether campaign is expired or not	true,false
activity_completed_total	Number	Total number of steps completed for activity associated with received event in campaign lifecycle	Positive numerical value
activity_completed_daily	Number	Total number of steps completed for activity associated with received event in daily lifecycle	Positive numerical value
activity_limits_total	Number	Total number of steps available for activity associated with received event in campaign lifecycle	Positive numerical value
activity_limits_daily	Number	Total number of steps available for activity associated with received event in daily lifecycle	Positive numerical value
campaign_activity_status	string(enum)	Current activity lifecycle state	Any String value (Including but not limited to "COMPLETED", "PENDING", "IN-PROGRESS”)
campaign_activity_id	string	Unique activity Id	Any String value
campaign_activity_event_name	string	Event name associated with activity	Any String value
campaign_activity_completed_on	string	UTC timestamp	Any String Value

Multistep activity Rollback

Triggered when a single activity rolls back for a multistep.

{
    "event_id": "63e7a694-e328-4cdf-91c9-5925988c503f",
    "type":"state-change",
    "client": "84acf2ac-b2e0-4927-8653-cba2b83816c2",
    "user_id": "glutest-21-oct-134",
    "analytics_version": "4.0.0",
    "timestamp": "2022-11-25T07:23:31Z",
    "campaign_details": {
            "campaign_id": "1593c385-e3cf-45ad-ad89-fb57732b6903",
            "campaign_name": "multistep",
            "campaign_experience": "MULTISTEP",
            "campaign_status": "COMPLETED",
            "campaign_steps_completed": 0,
            "campaign_total_steps": 1,
            "campaign_expires_on": "2022-11-26T18:29:59Z",
            "campaign_expiry_type": "RELATIVE",
            "campaign_expired": false,
            "campaign_activity": {
                "activity_completed_total": 3,
                "activity_completed_daily": 3,
                "activity_limits_total": 4,
                "activity_limits_daily": 4,
                "campaign_activity_status": "COMPLETED",
                "campaign_activity_id": "d7fa0ffe-e415-472d-86e0-388b754050a2",
                "campaign_activity_event_name": "Update Learning Progress",
                "campaign_activity_completed_on": "2022-11-25T07:12:21Z"
        }
    },
    "event_name": "MULTISTEP_ACTIVITY_ROLLBACK"
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	MULTISTEP_ACTIVITY_ROLLBACK
type	string	Event type	state-change
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	Any String value Including but not limited to "4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_name	string	Name of the campaign	Any String Value
campaign_experience	string	Experience of campaign	"MULTISTEP"
campaign_status	string	User’s state in campaign lifecycle	Any String value (Including but not limited to , 'IN-PROGRESS', 'COMPLETED', 'EXPIRED’ )
campaign_steps_completed	Number	Number of steps completed by user in campaign lifecycle	Positive numerical value
campaign_total_steps	Number	Total number of steps available in campaign lifecycle	Positive numerical value
campaign_expires_on	string	UTC timestamp	Any String Value
campaign_expiry_type	string(enum)	Type of expiration	'ABSOLUTE', 'RELATIVE', 'NEVER’
campaign_expired	boolean	flag whether campaign is expired or not	true,false
activity_completed_total	Number	Total number of steps completed for activity associated with received event in campaign lifecycle	Positive numerical value
activity_completed_daily	Number	Total number of steps completed for activity associated with received event in daily lifecycle	Positive numerical value
activity_limits_total	Number	Total number of steps available for activity associated with received event in campaign lifecycle	Positive numerical value
activity_limits_daily	Number	Total number of steps available for activity associated with received event in daily lifecycle	Positive numerical value
campaign_activity_status	string(enum)	Current activity lifecycle state	Any String value (Including but not limited to "COMPLETED", "PENDING", "IN-PROGRESS”)
campaign_activity_id	string	Unique activity Id	Any String value
campaign_activity_event_name	string	Event name associated with activity	Any String value
campaign_activity_completed_on	string	UTC timestamp	Any String Value

Streak Activity Completed

Triggered when a single activity gets completed for a streak.

{
    "event_id": "103ae181-751e-4f58-9015-eadcf0adda9c",
    "type":"state-change",
    "client": "84acf2ac-b2e0-4927-8653-cba2b83816c2",
    "user_id": "glutest-21-oct-134",
    "analytics_version": "4.0.0",
    "timestamp": "2022-11-25T08:27:48Z",
    "campaign_details": {
            "campaign_id": "072ab872-4407-4d19-aea9-c8d977c8cf93",
            "campaign_name": "streak is running",
            "campaign_experience": "STREAK",
            "campaign_status": "IN-PROGRESS",
            "campaign_steps_completed": 1,
            "campaign_total_steps": 5,
            "campaign_expires_on": "2022-12-05T18:29:59Z",
            "campaign_expiry_type": "RELATIVE",
            "campaign_expired": false,
            "campaign_activity": {
                "activity_completed_total": 1,
                "activity_completed_daily": 1,
                "activity_limits_total": 5,
                "activity_limits_daily": 5,
                "campaign_activity_status": "IN-PROGRESS",
                "campaign_activity_id": "CHECK_IN_ACTIVITY_ID",
                "campaign_activity_event_name": "CAMPAIGN_COMPLETED",
                "campaign_activity_completed_on": "2022-11-25T08:27:48Z"
            }
    },
    "event_name": "STREAK_ACTIVITY_COMPLETED"
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	STREAK_ACTIVITY_COMPLETED
type	string	Event type	state-change
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	Any String value Including but not limited to "4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_name	string	Name of the campaign	Any String Value
campaign_experience	string	Experience of campaign	"STREAK"
campaign_status	string	User’s state in campaign lifecycle	Any String value (Including but not limited to , 'IN-PROGRESS', 'COMPLETED', 'EXPIRED’ )
campaign_steps_completed	Number	Number of steps completed by user in campaign lifecycle	Positive numerical value
campaign_total_steps	Number	Total number of steps available in campaign lifecycle	Positive numerical value
campaign_expires_on	string	UTC timestamp	Any String Value
campaign_expiry_type	string(enum)	Type of expiration	'ABSOLUTE', 'RELATIVE', 'NEVER’
campaign_expired	boolean	flag whether campaign is expired or not	true,false
activity_completed_total	Number	Total number of steps completed for activity associated with received event in campaign lifecycle	Positive numerical value
activity_completed_daily	Number	Total number of steps completed for activity associated with received event in daily lifecycle	Positive numerical value
activity_limits_total	Number	Total number of steps available for activity associated with received event in campaign lifecycle	Positive numerical value
activity_limits_daily	Number	Total number of steps available for activity associated with received event in daily lifecycle	Positive numerical value
campaign_activity_status	string(enum)	Current activity lifecycle state	Any String value (Including but not limited to "COMPLETED", "PENDING", "IN-PROGRESS”)
campaign_activity_id	string	Unique activity Id	Any String value
campaign_activity_event_name	string	Event name associated with activity	Any String value
campaign_activity_completed_on	string	UTC timestamp	Any String Value

Streak activity Rollback

Triggered when a single activity rolls back for a streak.

{
    "event_id": "8b676c7d-9bfc-4eb3-925d-7a1a7fdd7929",
    "type":"state-change",
    "client": "84acf2ac-b2e0-4927-8653-cba2b83816c2",
    "user_id": "glutest-21-oct-134",
    "analytics_version": "4.0.0",
    "timestamp": "2022-11-25T08:29:21Z",
    "campaign_details": {
            "campaign_id": "072ab872-4407-4d19-aea9-c8d977c8cf93",
            "campaign_name": "streak is running",
            "campaign_experience": "STREAK",
            "campaign_status": "IN-PROGRESS",
            "campaign_steps_completed": 2,
            "campaign_total_steps": 5,
            "campaign_expires_on": "2022-12-05T18:29:59Z",
            "campaign_expiry_type": "RELATIVE",
            "campaign_expired": false,
            "campaign_activity": {
                "activity_completed_total": 2,
                "activity_completed_daily": 2,
                "activity_limits_total": 5,
                "activity_limits_daily": 5,
                "campaign_activity_status": "in-progress",
                "campaign_activity_id": "CHECK_IN_ACTIVITY_ID",
                "campaign_activity_event_name": "CAMPAIGN_COMPLETED",
                "campaign_activity_completed_on": "2022-11-25T08:28:21Z"
            }
    },
    "event_name": "STREAK_ACTIVITY_ROLLBACK"
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	STREAK_ACTIVITY_COMPLETED
type	string	Event type	state-change
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	Any String value Including but not limited to "4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_name	string	Name of the campaign	Any String Value
campaign_experience	string	Experience of campaign	"STREAK"
campaign_status	string	User’s state in campaign lifecycle	Any String value (Including but not limited to , 'IN-PROGRESS', 'COMPLETED', 'EXPIRED’ )
campaign_steps_completed	Number	Number of steps completed by user in campaign lifecycle	Positive numerical value
campaign_total_steps	Number	Total number of steps available in campaign lifecycle	Positive numerical value
campaign_expires_on	string	UTC timestamp	Any String Value
campaign_expiry_type	string(enum)	Type of expiration	'ABSOLUTE', 'RELATIVE', 'NEVER’
campaign_expired	boolean	flag whether campaign is expired or not	true,false
activity_completed_total	Number	Total number of steps completed for activity associated with received event in campaign lifecycle	Positive numerical value
activity_completed_daily	Number	Total number of steps completed for activity associated with received event in daily lifecycle	Positive numerical value
activity_limits_total	Number	Total number of steps available for activity associated with received event in campaign lifecycle	Positive numerical value
activity_limits_daily	Number	Total number of steps available for activity associated with received event in daily lifecycle	Positive numerical value
campaign_activity_status	string(enum)	Current activity lifecycle state	Any String value (Including but not limited to "COMPLETED", "PENDING", "IN-PROGRESS”)
campaign_activity_id	string	Unique activity Id	Any String value
campaign_activity_event_name	string	Event name associated with activity	Any String value
campaign_activity_completed_on	string	UTC timestamp	Any String Value

All MultiStep rewards consumed

Triggered when all the rewards in a multistep campaign are consumed.

{
  "event_name":"ALL_REWARDS_CONSUMED",
  "type":"state-change",
  "event_id":"018a34b1-71bb-4022-b410-cd0b015f136d",
  "client":"c6a4681d-5599-4ba3-bb7c-2XXXXXb",
  "user_id":"glutest-realUser",
  "analytics_version":"4.0.0",
  "timestamp":"2022-09-05T07:27:25.852Z",
  "campaign_details":{
      "campaign_id":"ewcw8ee0-474a-bxxqwqw-06f0b6c44a5",
      "campaign_experience":"STREAK",
      "campaign_status":"IN-PROGRESS",
      "campaign_steps_completed":1,
      "campaign_total_steps":2,
      "campaign_expires_on":"2021-06-18T08:30:52.937Z",
      "campaign_expiry_type":"RELATIVE",
      "campaign_expired":false
  }
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	“ALL_REWARDS_CONSUMED”
type	string	Event type	state-change
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	Any String value Including but not limited to "4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_experience	string	Experience of campaign	"MULTISTEP"
campaign_status	string	User’s state in campaign lifecycle	User’s state in campaign lifecycle Any String value (Including but not limited to 'PRISTINE' )
campaign_steps_completed	Number	Number of steps completed by user in campaign lifecycle	Positive numerical value
campaign_total_steps	Number	Total number of steps available in campaign lifecycle	Positive numerical value
campaign_expires_on	string	UTC timestamp	Any String Value
campaign_expiry_type	string(enum)	Type of expiration	'ABSOLUTE', 'RELATIVE', 'NEVER’
campaign_expired	boolean	flag whether campaign is expired or not	true,false

All Streak Rewards Consumed

Triggered when all the rewards in a streak campaign are consumed.

{
  "event_name":"ALL_REWARDS_CONSUMED",
  "type":"state-change",
  "event_id":"018a34b1-71bb-4022-b410-cd0b015f136d",
  "client":"c6a4681d-5599-4ba3-bb7c-2XXXXXb",
  "user_id":"glutest-realUser",
  "analytics_version":"4.0.0",
  "timestamp":"2022-09-05T07:27:25.852Z",
  "campaign_details":{
      "campaign_id":"ewcw8ee0-474a-bxxqwqw-06f0b6c44a5",
      "campaign_experience":"STREAK",
      "campaign_status":"IN-PROGRESS",
      "campaign_steps_completed":1,
      "campaign_total_steps":2,
      "campaign_expires_on":"2021-06-18T08:30:52.937Z",
      "campaign_expiry_type":"RELATIVE",
      "campaign_expired":false
  }
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	“ALL_REWARDS_CONSUMED”
type	string	Event type	state-change
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	Any String value Including but not limited to "4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_experience	string	Experience of campaign	"STREAK"
campaign_status	string	User’s state in campaign lifecycle	User’s state in campaign lifecycle Any String value (Including but not limited to 'PRISTINE' )
campaign_steps_completed	Number	Number of steps completed by user in campaign lifecycle	Positive numerical value
campaign_total_steps	Number	Total number of steps available in campaign lifecycle	Positive numerical value
campaign_expires_on	string	UTC timestamp	Any String Value
campaign_expiry_type	string(enum)	Type of expiration	'ABSOLUTE', 'RELATIVE', 'NEVER’
campaign_expired	boolean	flag whether campaign is expired or not	true,false

Reset Streak

It is triggered when the streak gets reset for a user, and the user has to start the progress from 1st streak.

{
	"event_id": "65b39b24-fe45-44b3-b8f1-54b7db050aff",
	"type":"state-change",
	"client": "84acf2ac-b2e0-4927-8653-cba2b83816c2",
	"user_id": "glutest-21-oct-81",
	"analytics_version": "4.0.0",
	"timestamp": "2022-11-17T07:03:42Z",
	"campaign_details": {
			"campaign_id": "072ab872-4407-4d19-aea9-c8d977c8cf93",
			"campaign_name": "streak is running",
			"campaign_experience": "STREAK",
			"campaign_status": "PRISTINE",
			"campaign_steps_completed": 2,
			"campaign_total_steps": 5,
			"campaign_expires_on": "2022-11-27T18:29:59Z",
			"campaign_expiry_type": "RELATIVE",
			"campaign_expired": false
		
	},
	"event_name": "RESET_STREAK"
}

FIELD	TYPE	DESCRIPTION	VALUES
event_name	string(enum)	Name of a particular event.	“STREAK_RESET”
type	string	Event type	state-change
event_id	string	Unique event Id	Any String Value
client	string	Your Client Id	Any String Value
user_id	string	User Identification.	Any String Value
analytics_version	string	Version of analytics event	Any String value Including but not limited to "4.0.0"
timestamp	string	UTC timestamp of the event	Any String Value
campaign_id	string	CampaignId of campaign	Any String Value
campaign_experience	string	Experience of campaign	"STREAK"
campaign_status	string	User’s state in campaign lifecycle	User’s state in campaign lifecycle Any String value (Including but not limited to 'PRISTINE' )
campaign_steps_completed	Number	Number of steps completed by user in campaign lifecycle	Positive numerical value
campaign_total_steps	Number	Total number of steps available in campaign lifecycle	Positive numerical value
campaign_expires_on	string	UTC timestamp	Any String Value
campaign_expiry_type	string(enum)	Type of expiration	'ABSOLUTE', 'RELATIVE', 'NEVER’
campaign_expired	boolean	flag whether campaign is expired or not	true,false

System

Work In Progress...