...
For Signup and google signin flow telemetry events need to be generated and this documentation consists all the telemetry events for signup and google sigin /up flow those are need to be generated during the events, actions of the signup and google signin /up flow.
Assumptions :
- As all the below telemetry events are pre login events ,actor is not specified in the events and values of actor will be "actor":be of below object value
actor: {
"id": "anonymous",
"type": "User"
} - sid , did inside context will be same in all the events so they haven't mentioned in the documentall the events.
Proposed Solution
Use cases for signup flow :
1.when user clicks on signup button once it is landed to signup form
...
| Code Block |
|---|
| language | js |
|---|
| title | interact event : sample example |
|---|
|
{
"eid": "INTERACT",
"ver": "3.0",
"context": {
"channel": "b00bc992ef25f1a9a8d63291e20efc8d",
"pdata": {
"id": "dev.sunbird.portal",
"ver": "1.13.0",
"pid": "sunbird-portal"
},
"env": "signup",
"cdata": [ {"type": "signup", "id": "<uuid>" }]
},
"edata": {
"id": "submit-signup",
"type": "click",
"pageid": "signup",
"extra": {
"radioOptioncontactType":"<radio option selected value (email / phone)>"
}
}
} |
...
| Code Block |
|---|
| language | js |
|---|
| title | impression event : sample example |
|---|
|
{
"eid": "IMPRESSION",
"context": {
"channel": "0123166367624478721",
"pdata": {
"id": "dev.sunbird.portal",
"ver": "1.13.0",
"pid": "sunbird-portal"
},
"env": "signup",
"cdata": [ {"type": "signup", "id": "<uuid>" }],
},
"edata": {
"type": "view",
"pageid": "otp",
"uri": "<otp url>/sign-up"
}
} |
5. On clicking of submit otp in otp page
...
| Code Block |
|---|
| language | js |
|---|
| title | Interact event : sample example |
|---|
|
{
"eid": "INTERACT",
"ver": "3.0",
"context": {
"channel": "b00bc992ef25f1a9a8d63291e20efc8d",
"pdata": {
"id": "dev.sunbird.portal",
"ver": "1.13.0",
"pid": "sunbird-portal"
},
"env": "signup",
"cdata": [ {"type": "otp", "id": "<uuid>" }]
},
"edata": {
"id": "submit-otp",
"type": "click",
"pageid": "otp",
"extra": {
"values":"<otp value>/sign-up"
}
}
} |
6. On clicking of resend otp in otp page
...
| Code Block |
|---|
| language | js |
|---|
| title | interact event : sample example |
|---|
|
{
"eid": "INTERACT",
"ver": "3.0",
"context": {
"channel": "b00bc992ef25f1a9a8d63291e20efc8d",
"pdata": {
"id": "dev.sunbird.portal",
"ver": "1.13.0",
"pid": "sunbird-portal"
},
"env": "signup",
"cdata": [ {"type": "otp", "id": "<uuid>" }]
},
"edata": {
"id": "resend-otp",
"type": "click",
"pageid": "otp",
}
} |
...
| Code Block |
|---|
| language | js |
|---|
| title | End event Interact Event : sample example |
|---|
|
{
"eid": "ENDINTERACT",
"context": {
"channel": "b00bc992ef25f1a9a8d63291e20efc8d",
"pdata": {
"id": "dev.sunbird.portal",
"ver": "1.13.0",
"pid": "sunbird-portal"
},
"env": "signupotp",
"cdata": [ {"type": "signupotp", "id": "<uuid>" }],
},
"edata": {
"typepageid": "signupotp",
"type": "click",
"pageidid": "signupsend-otp",
"extra": {
"modeisError": "selftrue"
}
}
} |
...
8. on
...
resend otp api error
| Code Block |
|---|
| language | js |
|---|
| title | Interact Event : sample example |
|---|
|
{
"eid": "InteractINTERACT",
"context": {
"channel": "b00bc992ef25f1a9a8d63291e20efc8d",
"pdata": {
"id": "dev.sunbird.portal",
"ver": "1.13.0",
"pid": "sunbird-portal"
},
"env": "otp",
"cdata": [ {"type": "otp", "id": "<uuid>" }],
},
"edata": {
"pageid": "otp",
"type": "click",
"id": "sendresend-otp",
"extra": {
"sendOtpFailedisError":"true"
}
}
} |
...
9. End event for : Signup submit api error / Error of submit otp (on api failure, not on invalid otp) / success of submit otp in signup flow
| Code Block |
|---|
| language | js |
|---|
| title | Interact Event End event : sample example |
|---|
|
{
"eid": "InteractEND",
"context": {
"channel": "b00bc992ef25f1a9a8d63291e20efc8d",
"pdata": {
"id": "dev.sunbird.portal",
"ver": "1.13.0",
"pid": "sunbird-portal"
},
"env": "otpsignup",
"cdata": [ {"type": "otpsignup", "id": "<uuid>" }],
},
"edata": {
"pageidedata": "otp",
{
"type": "clicksignup",
"idpageid": "resend-otpsignup",
"extra":
{ "resendOtpFailedmode": "trueself"
} }
} |
Log events for signup flow :
...
| Code Block |
|---|
| language | js |
|---|
| title | Log Event : sample example |
|---|
|
{
"eid": "LOG",
"context": {
"channel": "b00bc992ef25f1a9a8d63291e20efc8d",
"pdata": {
"id": "dev.sunbird.portal",
"ver": "1.13.0",
"pid": "sunbird-portal"
},
"env": "otp",
"cdata": [ {"type": "otp", "id": "<uuid>" }],
},
"edata": {
"pageid": "otp",
"type": "api_call",
"level": "ERROR",
"message": "otp verification failed",
"extra": {
"values":"<otp value>"
}
}
} |
3. create user error after otp verified in signup flow
...
Log events of google signIn
1. on success full
...
response of user details from google
...
sigin
| Code Block |
|---|
| language | js |
|---|
| title | Log Event : sample example |
|---|
|
{
"eid": "LOG",
"context": {
"channel": "b00bc992ef25f1a9a8d63291e20efc8d",
"pdata": {
"id": "dev.sunbird.portal",
"ver": "1.13.0",
"pid": "sunbird-portal"
},
"env": "signin",
"cdata": [ {"type": "signin", "id": "<uuid>" }],
},
"edata": {
"pageid": "signin",
"type": "api_access",
"level": "INFO",
"message": "successfull recieved user details from google"
}
} |
...
| Code Block |
|---|
| language | js |
|---|
| title | Log Event : sample example |
|---|
|
{
"eid": "LOG",
"context": {
"channel": "b00bc992ef25f1a9a8d63291e20efc8d",
"pdata": {
"id": "dev.sunbird.portal",
"ver": "1.13.0",
"pid": "sunbird-portal"
},
"env": "otp",
"cdata": [ {"type": "signin", "id": "<uuid>" }],
},
"edata": {
"pageid": "signin",
"type": "api_call",
"level": "ERROR",
"message": "user creation failed"
}
} |
Audit Events : (what should be the values for edata
...
audit events)
1.after user is created from self signup :
...