Continuous Watching V2 API (v2-2022-09-01)

Download OpenAPI specification:

Save continuous watching data

header Parameters

ODK-Service-Name

required

string

Enum: "odk" "odl" "odc"

Which service

Request Body schema: application/json

user_id required	integer (User ID)
session_key required	string or null (Session Key (Only guest user))
program_id required	integer (ODX Program ID)
episode_id required	integer (ODX Episode ID)
duration required	float (Video duration)
last_position required	float (Who user last played position)
total_play_time	float (Who user total played time)

Responses

Response Schema: application/json

user_id required	integer (User ID)
session_key required	string or null (Session Key (Only guest user))
program_id required	integer (ODX Program ID)
episode_id required	integer (ODX Episode ID)
duration required	float (Video duration)
last_position required	float (Who user last played position)
total_play_time	float (Who user total played time)

Request samples

Payload

Content type

application/json

{"user_id": 1,
"program_id": 123,
"episode_id": 456,
"duration": 2048.4096,
"last_position": 512.1204,
"total_play_time": 1024.2048
}

Response samples

201

Content type

application/json

{"user_id": 1,
"program_id": 123,
"episode_id": 456,
"duration": 2048.4096,
"last_position": 512.1204,
"total_play_time": 1024.2048
}

Get continuous watching data by user

path Parameters

user_id

required

integer

header Parameters

ODK-Service-Name

required

string

Enum: "odk" "odl" "odc"

Which service

Responses

Response Schema: application/json

Array of objects (ContinuousWatchingHistory)

Array

id	string (Unique ID)
user_id	integer (User ID)
session_key	string or null (Session Key (Only guest user))
program_id	integer (ODX Program ID)
episode_id	integer (ODX Episode ID)
duration	float (Video duration)
last_position	float (Who user last played position)
total_play_time	float (Who user total played time)
progress_ratio	float (Progress Ratio)
watched	boolean (Watched boolean)
deleted	boolean (Deleted boolean)
created_at	datetime (Created At)
updated_at	datetime (Updated At)

Response samples

200

Content type

application/json

{"results": [{"id": "62fd174a12950aaffcf3a176",
"user_id": 1,
"session_key": null,
"program_id": 123,
"episode_id": 456,
"duration": 2048.4096,
"last_position": 512.1204,
"total_play_time": 1024.2048,
"progress_ratio": 50.2463054187192,
"watched": false,
"deleted": false,
"created_at": "2022-08-17T16:28:58.682Z",
"updated_at": "2022-08-25T15:27:10.29Z"
}
]
}

Get continuous watching latest episode each program by user

path Parameters

user_id

required

integer

header Parameters

ODK-Service-Name

required

string

Enum: "odk" "odl" "odc"

Which service

Responses

Response Schema: application/json

Array of objects (ContinuousWatchingHistory)

Array

id	string (Unique ID)
user_id	integer (User ID)
session_key	string or null (Session Key (Only guest user))
program_id	integer (ODX Program ID)
episode_id	integer (ODX Episode ID)
duration	float (Video duration)
last_position	float (Who user last played position)
total_play_time	float (Who user total played time)
progress_ratio	float (Progress Ratio)
watched	boolean (Watched boolean)
deleted	boolean (Deleted boolean)
created_at	datetime (Created At)
updated_at	datetime (Updated At)

Response samples

200

Content type

application/json

{"results": [{"id": "62fd174a12950aaffcf3a176",
"user_id": 1,
"session_key": null,
"program_id": 123,
"episode_id": 456,
"duration": 2048.4096,
"last_position": 512.1204,
"total_play_time": 1024.2048,
"progress_ratio": 50.2463054187192,
"watched": false,
"deleted": false,
"created_at": "2022-08-17T16:28:58.682Z",
"updated_at": "2022-08-25T15:27:10.29Z"
}
]
}

Get watch history data by user

path Parameters

user_id

required

integer

header Parameters

ODK-Service-Name

required

string

Enum: "odk" "odl" "odc"

Which service

Responses

Response Schema: application/json

Array of objects (ContinuousWatchingHistory)

Array

id	string (Unique ID)
user_id	integer (User ID)
session_key	string or null (Session Key (Only guest user))
program_id	integer (ODX Program ID)
episode_id	integer (ODX Episode ID)
duration	float (Video duration)
last_position	float (Who user last played position)
total_play_time	float (Who user total played time)
progress_ratio	float (Progress Ratio)
watched	boolean (Watched boolean)
deleted	boolean (Deleted boolean)
created_at	datetime (Created At)
updated_at	datetime (Updated At)

Response samples

200

Content type

application/json

{"results": [{"id": "62fd174a12950aaffcf3a176",
"user_id": 1,
"session_key": null,
"program_id": 123,
"episode_id": 456,
"duration": 2048.4096,
"last_position": 512.1204,
"total_play_time": 1024.2048,
"progress_ratio": 50.2463054187192,
"watched": false,
"deleted": false,
"created_at": "2022-08-17T16:28:58.682Z",
"updated_at": "2022-08-25T15:27:10.29Z"
}
]
}

Delete watch history data by user

path Parameters

user_id

required

integer

header Parameters

ODK-Service-Name

required

string

Enum: "odk" "odl" "odc"

Which service

Responses

Get continuous watching data by user, episode

path Parameters

user_id required	integer
episode_id required	integer

header Parameters

ODK-Service-Name

required

string

Enum: "odk" "odl" "odc"

Which service

Responses

Response Schema: application/json

object (ContinuousWatchingHistory)

id	string (Unique ID)
user_id	integer (User ID)
session_key	string or null (Session Key (Only guest user))
program_id	integer (ODX Program ID)
episode_id	integer (ODX Episode ID)
duration	float (Video duration)
last_position	float (Who user last played position)
total_play_time	float (Who user total played time)
progress_ratio	float (Progress Ratio)
watched	boolean (Watched boolean)
deleted	boolean (Deleted boolean)
created_at	datetime (Created At)
updated_at	datetime (Updated At)

Response samples

200

Content type

application/json

{"result": {"id": "62fd174a12950aaffcf3a176",
"user_id": 1,
"session_key": null,
"program_id": 123,
"episode_id": 456,
"duration": 2048.4096,
"last_position": 512.1204,
"total_play_time": 1024.2048,
"progress_ratio": 50.2463054187192,
"watched": false,
"deleted": false,
"created_at": "2022-08-17T16:28:58.682Z",
"updated_at": "2022-08-25T15:27:10.29Z"
}
}

Delete watch history data by user, episode

path Parameters

user_id

required

integer

header Parameters

ODK-Service-Name

required

string

Enum: "odk" "odl" "odc"

Which service

Responses

Get continuous watching data by user, program

path Parameters

user_id required	integer
program_id required	integer

header Parameters

ODK-Service-Name

required

string

Enum: "odk" "odl" "odc"

Which service

Responses

Response Schema: application/json

Array of objects (ContinuousWatchingHistory)

Array

id	string (Unique ID)
user_id	integer (User ID)
session_key	string or null (Session Key (Only guest user))
program_id	integer (ODX Program ID)
episode_id	integer (ODX Episode ID)
duration	float (Video duration)
last_position	float (Who user last played position)
total_play_time	float (Who user total played time)
progress_ratio	float (Progress Ratio)
watched	boolean (Watched boolean)
deleted	boolean (Deleted boolean)
created_at	datetime (Created At)
updated_at	datetime (Updated At)

Response samples

200

Content type

application/json

{"results": [{"id": "62fd174a12950aaffcf3a176",
"user_id": 1,
"session_key": null,
"program_id": 123,
"episode_id": 456,
"duration": 2048.4096,
"last_position": 512.1204,
"total_play_time": 1024.2048,
"progress_ratio": 50.2463054187192,
"watched": false,
"deleted": false,
"created_at": "2022-08-17T16:28:58.682Z",
"updated_at": "2022-08-25T15:27:10.29Z"
}
]
}