0% found this document useful (0 votes)
14 views7 pages

Telemetry Docs

Uploaded by

ashok reddy
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
14 views7 pages

Telemetry Docs

Uploaded by

ashok reddy
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 7

What is telemetry?

• Telemetry is a library which uses to capture events.(Or) These are the


events which we Used to capture to identify the User Actions during
his/ her visit throughout the portal/app.
What are the events in telemetry?
• INTERACT
• IMPRESSION
• START
• END
• ACCESS
• INTERRUPT
• ASSESS
• AUDIT
• SHARE
• LOG
• SEARCH
What is INTERACT Event?
• INTERACT: Any click action performed by the user is called as interact
event. It may be created due to SEARCH,CLICK, PREVIEW, MOVE, Resize
etc.

"eid": "INTERACT",

What is IMPRESSION Event?


• IMPRESSION: Any opening of the new page is an impression event OR IN
SIMPLE WORD “A VISIT TO A SPECIFIC PAGE BY USER”.

"eid": "IMPRESSION",

Here event id is: IMPRESSION


What is START Event?
START is initiate during any work flow starts. It may be session start, it may be
app start
What is END Event?
END will initiate at the end of workflow.
Note: Make sure whenever there is START event there must be an END event.

What is ACCESS Event?


When we play assessment type content then this event will initiate.

What is AUDIT Event?


When an object is changed. This includes lifecycle changes as well.

What is SHARE Event?


When any share happens. For ex: Share content, telemetry data, link, file etc
What is LOG Event?
This will initiate during API call, Service call, app update etc.

What is SEARCH Event?


This will initiate during search actions performed by User.
What is mid?
For duplication check we mainly use message ID
• Each page will have unique mid. For every actions separate mid will get
create.
What is ACTOR?
• ACTOR : Actor is a user who perform the action on page.
Actor should have-
1. Id
2. Type

For logged in users actor type should be “User”


For eg.
actor{
id: 709a3152-32bd-428d-a4f9-30445e4ea573
type: user
}
For normal visitor (with out logged in) actor type should be “anonymous”
For eg.
actor{
id: anonymous
type: user
}
What is channel ?
• Channel : Channel is a state id

"context": {
"channel": "0124511394914140160",
"pdata": {
"id": "staging.diksha.portal",
"ver": "1.15.0",
"pid": "sunbird-portal"
},

What is the Producer data?


• Producer data: The producer is the mobile/portal on which the user
perform the action. We also called them as pdata.

"pdata": {
"id": "staging.diksha.portal",
"ver": "1.15.0",
"pid": "sunbird-portal"
},

Here pdata.id is the in which environment user perform the action.


Ver is the version in which the environment belongs
Pdata.pid is the environment where it is generating from.

What is Device Id?


• Device id: It is the id of device for system and mobile. We denote them as
“did”

"did": "aea7a0dca71db003f3f7a4f61ab0c1df",
• It should be unique for every device.
• Each time the device id will be same for single system.

What is Environment?
• Environment : It is the page where the user is performing some action.
For eg. "env": "home",
What is Object ?
• Object: Action perform on the things is called object
• Like creation, consumption, editing

object": {
id:
type: Content
version:
}
What is Event data?
• Event data: This are the different actions performed by user like click,
drag, touch, view

"edata": {
"type": "view",
"pageid": "home",
"uri": "/home",
"subtype": "paginate"
}

For impression event type should be view


"type": "view",

For interact event type should be click


"type": "click",
What is Page Id?

• Page id: The page id is the page where the user doing action

"pageid": "home",

What is subtype?
• Subtype : The subtype is the action which is going to happen after Interact
event.

"subtype": "paginate"

What is session id?


• Session id: It is the time interval when the user performing the action on
an page.
• It should be alphanumeric

"sid": "ZpucqQqGgz8FilcJbiaNmumHMNnTosrE",

For logged in user

"sid": "ZpucqQqGgz8FilcJbiaNmumHMNnTosrE",

For anonymous user

"sid": "",

You might also like