Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property name

Description

optional/Required

With property

Without property

Comment

Default

1

mode

To identify preview used by the user to play/edit/preview

Optional

No change in telemetry data

No change in telemetry data

Can be set it as preview from the player side. There is no major impact in player preview.

"preview"

2

authToken

Auth key to make the api call

Optional

No change in telemetry data

No change in telemetry data

As we are not calling any api from player side authtoken property can be optional.

“ “

3

sid

User sessionId

Required

sid will log in telemetry

sid will not log in telemetry

Default can be set from player side

“ ”

4

did

Unique id to identify the device

Required

did will log in telemetry

did will not log in telemetry

Default can be set from player side

“ “

5

uid

Current logged in user id

Required

uid will log in telemetry

uid will not log in telemetry

Default can be set from player side

"anoymous"

6

channel

Unique id of the channel

Required

channel id will log in telemetry

channel id will not log in telemetry

This can be a optional and can be set it from player side a a default parameter.

“ “

7

pdata

producer id

Required

{
"id": "sunbird.portal",
"ver": "3.2.12",
"pid": "sunbird-portal.contentplayer"
}

{}

Default can be set from player side

{}

8

contextRollup

Defines the content rollup data

Optional

Context rollup will log in telemetry context

content rollup will not log in context

Its a optional field in telemetry

{}

9

objectRollup

Defines the content object data

Optional

Object rollup will log in telemetry

Object rollup will not log in telemetry

Its a optional field in telemetry

{}

10

tags

defines the tags data

Optional

Tag will log

Empty tag list will log

Its a optional tags data

{}

11

cdata

Defines the correlation data

Optional

Cdata will log

cdta will log in telemetry

Correlation data requires for telemetry

{}

12

timeDiff

It defines the time difference

Optional

No change in telemetry data

No change in telemetry data

This can be a optional field

“ “

13

host

Defines the from which domain content should be loaded

Optional

No change in telemetry data

No change in telemetry data

Default can be set from player side

“ “

14

endpoint

It defines the endpoint

Optional

No change in telemetry data

No change in telemetry data

This can be a optional

/data/v3/telemetry

15

userData

Defines the user first name and last name

Optional

End page will show the first name and last name from userData

User first and lastname will not show in endpage

Default can be set from player side

{
"firstName": "anoymous",
"lastName": ""
}

...