ODK API Portal
한국어
  • Overview
  • MediaIO
  • Continue Watching
  • Player Event
  • Deprecated
  • Recent changes
Information
Player Events v2 (ODK)
Telemetry
Player Events v2 (Amasian legacy)
    First rendered frame (Amasian legacy)getStart a playback session (Amasian legacy)getWatch-time tick (Amasian legacy)get
Schemas
powered by Zudoku
Player Event API V2
Player Event API V2

Player Events v2 (Amasian legacy)

Original /api/v2/* routes used by Amasian clients. Behaviour unchanged. Requires s on playlist; drives Continue Watching (Redis) when mci and did or u are present: a signed-in viewer's u (the Amasian user uuid) saves it to the account, otherwise it is saved to the device.


First rendered frame (Amasian legacy)

GET
https://pe.odkmedia.io
/api/v2/firstplay

First rendered frame (Amasian legacy) › query Parameters

ss
​string · required

stream session id

stream session id

dt
​string · required

Client send time, epoch milliseconds.

Client send time, epoch milliseconds.

First rendered frame (Amasian legacy) › Responses

Successful Response

No data returned
GET/api/v2/firstplay
curl 'https://pe.odkmedia.io/api/v2/firstplay?ss=<string>&dt=<string>'
Example Responses
{}
json
application/json

Start a playback session (Amasian legacy)

GET
https://pe.odkmedia.io
/api/v2/playlist

Collects the playlist event that starts a playback session and returns the stream session id. Behaviour unchanged for Amasian clients; ODK clients use /api/v2/odk/*.

Start a playback session (Amasian legacy) › query Parameters

s
​string · required

Service name: amasian, odc, ... ODK traffic uses the dedicated /api/v2/odk/* routes.

Service name: amasian, odc, ... ODK traffic uses the dedicated /api/v2/odk/* routes.

dt
​string · required

Client send time, epoch milliseconds.

Client send time, epoch milliseconds.

did
​

Client-generated persistent device id: in an app, stable across app restarts and app updates; on web, a first-party UUID in localStorage with a cookie fallback. Send on every event, and send the same value on player events and telemetry — it is the join key between the two surfaces, so two separately minted UUIDs break the join silently. (Audience counting lives on the telemetry surface, not on player events.)

Client-generated persistent device id: in an app, stable across app restarts and app updates; on web, a first-party UUID in localStorage with a cookie fallback. Send on every event, and send the same value on player events and telemetry — it is the join key between the two surfaces, so two separately minted UUIDs break the join silently. (Audience counting lives on the telemetry surface, not on player events.)

opid
​

OneSignal player id.

OneSignal player id.

p
​

Platform, e.g. web, ios, android, tvos, roku, tizen, webos, firetv.

Platform, e.g. web, ios, android, tvos, roku, tizen, webos, firetv.

si
​

hotel tv only [techworld_marriott_fullerton]

hotel tv only [techworld_marriott_fullerton]

st
​

stream type [live, on-demand, multiview]

stream type [live, on-demand, multiview]

mci
​

mediahub content id

mediahub content id

ch
​

channel slug

channel slug

sl
​

subtitle language

subtitle language

r
​

Attribution for recommendation engine, Empty if engine is not used. [aws_personal, odk_reco]

Attribution for recommendation engine, Empty if engine is not used. [aws_personal, odk_reco]

att
​

Attribution Source [free-to-watch, continue-watching]

Attribution Source [free-to-watch, continue-watching]

attr_value
​

Attribution of the playback [watch_full, startover, next_episode, click_next_episode, auto_next_play, continue_watching, search, main_banner, etc]

Attribution of the playback [watch_full, startover, next_episode, click_next_episode, auto_next_play, continue_watching, search, main_banner, etc]

av
​

App version

App version

c
​

domain of stream [ol.ondemandkorea.com, hls, kleenex]

domain of stream [ol.ondemandkorea.com, hls, kleenex]

u
​

User id (spec u, LOGGED-IN only). For Amasian send the signed-in user's uuid (uuid from user/profile/); omit for guests. With s=amasian, a uuid saves Continue Watching for this playback to the account instead of the device. Any other value, or any other s, is stored on the event as sent and leaves Continue Watching on the device.

User id (spec u, LOGGED-IN only). For Amasian send the signed-in user's uuid (uuid from user/profile/); omit for guests. With s=amasian, a uuid saves Continue Watching for this playback to the account instead of the device. Any other value, or any other s, is stored on the event as sent and leaves Continue Watching on the device.

Start a playback session (Amasian legacy) › Responses

Event accepted. Use stream_session_id on the rest of the session.

Response of the playlist routes: the server-issued stream session id.
PlaylistResponse
stream_session_id
​string · required

Server-issued stream session id (ss). Carry it on firstplay and viewhour of the same session.

GET/api/v2/playlist
curl 'https://pe.odkmedia.io/api/v2/playlist?s=<string>&dt=<string>'
Example Responses
{ "stream_session_id": "550e8400-e29b-41d4-a716-446655440000" }
json
application/json

Watch-time tick (Amasian legacy)

GET
https://pe.odkmedia.io
/api/v2/viewhour

Watch-time tick (Amasian legacy) › query Parameters

ss
​string · required

stream session id

stream session id

dt
​string · required

Client send time, epoch milliseconds.

Client send time, epoch milliseconds.

v
​number · required

Seconds watched in this tick (default 5; final tick carries the measured value).

Seconds watched in this tick (default 5; final tick carries the measured value).

wp
​

Current watching position from the player controller [4186.12]

Current watching position from the player controller [4186.12]

sl
​

Active subtitle selected (en,ko ..) (empty if no subtitle selected)

Active subtitle selected (en,ko ..) (empty if no subtitle selected)

Watch-time tick (Amasian legacy) › Responses

Successful Response

No data returned
GET/api/v2/viewhour
curl 'https://pe.odkmedia.io/api/v2/viewhour?ss=<string>&dt=<string>&v=<number>'
Example Responses
{}
json
application/json

Telemetry