# Analytics schema V4 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 ```json { "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" } } ```
FIELDTYPEDESCRIPTIONVALUES, (subject to change in case of updates)
event_namestringPAGE_OPENED: When a page, sub-page, nudge page, or any custom page is openedPAGE_OPENED
typestringType of eventpage
event_id, eventIdstringEvent Identificationunique string value
user_id, userIdstringUser Identification.respective user id received from client app
timestampstringISO UTC timestamp of the event.time at event fired
session_idstringuser session idAny unique string value
session_timenumbertime spent by the user till this eventin milliseconds
referrerstringsource of the redirection, it’s an OPTIONAL PROPERTYoptional property
analytics_versionstringanalytic version used for the respective campaignsAny string value with semantic versioning
page_detailsobjectrepresents the current page details
page_layoutstringrepresents the type layout used for this page.FULL_PAGE, BOTTOM_SHEET, POPUP
page_namestringname of the page opened. subject to change in case of different pages are added to the campaignsAny 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_detailsobjectIt’s an optional property. Available only for campaign-level ui’s.optional
campaign_namestringname of the campaign opened by the userAny string value
campaign_experiencestringtype of the campaignAny 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_idstringunique reward id of the user for the particular campaignAny string value
campaign_statestringuser’s campaign state for the opened campaignPRISTINE, IN_PROGRESS, COMPLETED
reward_statusstringuser’s reward state for the opened campaignREDEEMABLE-SEEN, REDEEMABLE-UNSEEN
selected_slot_index numberindex of the slot selected based on the probabilityAny number starting from 0
reward_typestringtype of reward

Any string value, including but not limited to:

["NO_REWARD", "CUSTOM_REWARD", "COUPONS", "COINS", "POINTS", "CASHBACKS", "DIRECT"]

reward_title stringtitle of rewardAny string value
reward_amountnumbernumeric component of the rewardAny number
coupon_codestringCoupon code (if eligible)Any string value
platform_detailsuser platform details
device_typestringuser device typeMOBILE, WEB
osstringoperating system of the userCHROME, ANDROID, IOS, MICROSOFT
agent_typestringuser agent of the uiWEB_VIEW, BROWSER, IFRAME
app_platformstringuser app typeFLUTTER, ANDROID, IOS, WEB
optional_payloadobjectany custom properties can be added, for better analyticskey and value pairs
### Track- Frontend ```json { "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"}, } ```
FIELDTYPEDESCRIPTIONVALUES, (subject to change in case of updates)
event_namestringuser 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"
typestringType of eventtrack
event_id, eventIdstringEvent Identificationunique string value
user_id, userIdstringUser Identification.respective user id received from client app
timestampstringISO UTC timestamp of the event.time at which event triggered
session_idstringuser session idAny unique string value
session_timenumbertime spent by the user till this eventin milliseconds
referrerstringsource of the redirectionAny string value
analytics_versionstringanalytic version used for the respective campaignsAny string value with semantic versioning
page_detailsobjectrepresents the current page details
page_layoutstringrepresents the type layout used for this page.FULL_PAGE, BOTTOM_SHEET, POPUP
page_namestringname of the page opened. subject to change in case of different pages are added to the campaignsAny 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_detailsobjectIt’s an optional property. Available only for campaign-level interactions.optional
campaign_namestringname of the campaign opened by the userAny string value
campaign_experiencestringtype of the campaignAny 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_idstringunique reward id of the user for the particular campaignAny string value
campaign_statestringuser’s campaign state for the opened campaignPRISTINE, IN_PROGRESS, COMPLETED
reward_statusstringuser’s reward state for the opened campaignREDEEMABLE-SEEN, REDEEMABLE-UNSEEN
selected_slot_indexnumberSelected slot index based on the probabilityAny number starting from 0
reward_typestringType of the reward

Any string value, including but not limited to:

["NO_REWARD", "CUSTOM_REWARD", "COUPONS", "COINS", "POINTS", "CASHBACKS", "DIRECT"]

reward_titlestringTitle of the rewardAny string value
reward_amountnumberNumeric component of the rewardAny number
coupon_codestringCoupon code (if eligible)Any string value
platform_detailsobjectuser platform details
device_typestringuser device typeMOBILE, WEB
osstringthe operating system of the userCHROME, ANDROID, IOS, MICROSOFT
agent_typestringuser agent of the uiWEB_VIEW, BROWSER, IFRAME
app_platformstringuser app typeFLUTTER, ANDROID, IOS, WEB
optional_payloadobjectany custom properties can be added, for better analyticsIt’s an optional payload
interaction_detailsobjectuser interaction (click) detailsIt’s an optional object, sub-properties depend on the event_name
button_namestringbutton name of this click eventname of the button
codestringcode copied by userAny string value
deep_linkstringdeeplink opened by userAny string value
web_linkstringweb link opened by userAny string value
channelstringshare channelWHATSAPP, etc
session_idstringunique quiz session idAny string value
question_indexnumberquestion id of the current usernumber
user_answerstringuser answer for the questionAny string value
user_answersarrayin case of multiple answers (surveys)Array of strings
correct_answerstringcorrect answer for the questionAny string value
is_correctbooleanuser answer statetrue, false
survey_page_indexnumbercurrent survey page idnumber
field_typestringcurrent question typeTEXT_INPUT, CHECK_BOX, DROP_DOWN, RATINGS
survey_question_indexnumbercurrent survey question idnumber
questionstringsurvey questionAny string value
### Track-SDK #### Webview Load ```json { "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 ```json { "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) ```json { "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 ```json { "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 ```json { "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 ```json { "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 ```json { "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 ```json { "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) ```json { "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. ```json { "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. ```json { "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) ```json { "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. ```json { "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. ```json { "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" } ```
FIELDTYPEDESCRIPTIONVALUES
event_namestring(enum)Name of a particular event.CAMPAIGN_JOINED
typestringEvent typestate-change
event_idstringUnique event IdAny String Value
clientstringYour Client IdAny String Value
user_idstringUser Identification.Any String Value
analytics_versionstringVersion of analytics eventAny String value Including but not limited to "4.0.0"
timestampstringUTC timestamp of the eventAny String Value
campaign_idstringCampaignId of campaignAny String Value
campaign_namestringName of the campaignAny String Value
campaign_experiencestringExperience of campaign"MULTISTEP","STREAK"
campaign_statusstringUser’s state in campaign lifecycleUser’s state in campaign lifecycle Any String value (Including but not limited to 'PRISTINE' )
campaign_steps_completedNumberNumber of steps completed by user in campaign lifecyclePositive numerical value
campaign_total_stepsNumberTotal number of steps available in campaign lifecyclePositive numerical value
campaign_expires_onstringUTC timestampAny String Value
campaign_expiry_typestring(enum)Type of expiration'ABSOLUTE', 'RELATIVE', 'NEVER’
campaign_expiredbooleanflag whether campaign is expired or nottrue,false
#### **MultiStep** **Activity completed** Triggered when a user completes an activity in a multistep campaign ```json { "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. ```json { "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. ```json { "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. ```json { "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. ```json { "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. ```json { "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. ```json { "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... --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.customerglu.com/schema/analytics-schema-v4.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.