Other endpoints

Save continuous watching data

POST

https://cw.odkmedia.io/v3

/cw

Save continuous watching data › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Save continuous watching data › Request Body

SaveContinuousWatching

duration

float · required

episode_id

integer · required

is_primary

boolean · required

last_position

float · required

profile_id

integer · required

program_id

integer · required

session_key

string · required

total_play_time

float · required

user_id

integer · required

Save continuous watching data › Responses

SaveContinuousWatching

duration

float · required

episode_id

integer · required

is_primary

boolean · required

last_position

float · required

profile_id

integer · required

program_id

integer · required

session_key

string · required

total_play_time

float · required

user_id

integer · required

POST/cw

curl https://cw.odkmedia.io/v3/cw \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'ODK-Service-Name: <string>' \
  --data '{
  "duration": 2048.4096,
  "episode_id": 456,
  "is_primary": false,
  "last_position": 512.1204,
  "profile_id": 23,
  "program_id": 123,
  "session_key": null,
  "total_play_time": 1024.2048,
  "user_id": 1
}'

Example Request Body

{
  "duration": 2048.4096,
  "episode_id": 456,
  "is_primary": false,
  "last_position": 512.1204,
  "profile_id": 23,
  "program_id": 123,
  "session_key": null,
  "total_play_time": 1024.2048,
  "user_id": 1
}

json

application/json

Example Responses

{
  "duration": 2048.4096,
  "episode_id": 456,
  "is_primary": false,
  "last_position": 512.1204,
  "profile_id": 23,
  "program_id": 123,
  "session_key": null,
  "total_play_time": 1024.2048,
  "user_id": 1
}

json

application/json

Get continuous watching data by profile

GET

https://cw.odkmedia.io/v3

/cw/users/{user_id}/profiles/{profile_id}

Get continuous watching data by profile › path Parameters

user_id

integer · required

profile_id

integer · required

Get continuous watching data by profile › query Parameters

is_primary

bool · enum · required

Enum values:

page_size

number · min: 0 · max: 100

Get continuous watching data by profile › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Get continuous watching data by profile › Responses

200

results

Get continuous watching data by profile, episode

GET

https://cw.odkmedia.io/v3

/cw/users/{user_id}/profiles/{profile_id}/episodes/{episode_id}

Get continuous watching data by profile, episode › path Parameters

user_id

integer · required

profile_id

integer · required

episode_id

integer · required

Get continuous watching data by profile, episode › query Parameters

is_primary

bool · enum · required

Enum values:

Get continuous watching data by profile, episode › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Get continuous watching data by profile, episode › Responses

200

ContinuousWatchingHistory

Delete watch history data by profile, episode

DELETE

https://cw.odkmedia.io/v3

/cw/users/{user_id}/profiles/{profile_id}/episodes/{episode_id}

Delete watch history data by profile, episode › path Parameters

user_id

integer · required

profile_id

integer · required

episode_id

integer · required

Delete watch history data by profile, episode › query Parameters

is_primary

bool · enum · required

Enum values:

Delete watch history data by profile, episode › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Delete watch history data by profile, episode › Responses

No data returned

Get continuous watching latest episode each program by profile

GET

https://cw.odkmedia.io/v3

/cw/users/{user_id}/profiles/{profile_id}/latest-episode

Get continuous watching latest episode each program by profile › path Parameters

user_id

integer · required

profile_id

integer · required

Get continuous watching latest episode each program by profile › query Parameters

is_primary

bool · enum · required

Enum values:

Get continuous watching latest episode each program by profile › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Get continuous watching latest episode each program by profile › Responses

200

results

GET/cw/users/{user_id}/profiles/{profile_id}/latest-episode

curl 'https://cw.odkmedia.io/v3/cw/users/:user_id/profiles/:profile_id/latest-episode?is_primary=<value>' \
  --header 'ODK-Service-Name: <string>'

Example Responses

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

json

application/json

Get continuous watching data by profile, program

GET

https://cw.odkmedia.io/v3

/cw/users/{user_id}/profiles/{profile_id}/programs/{program_id}

Get continuous watching data by profile, program › path Parameters

user_id

integer · required

profile_id

integer · required

program_id

integer · required

Get continuous watching data by profile, program › query Parameters

is_primary

bool · enum · required

Enum values:

Get continuous watching data by profile, program › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Get continuous watching data by profile, program › Responses

200

results

GET/cw/users/{user_id}/profiles/{profile_id}/programs/{program_id}

curl 'https://cw.odkmedia.io/v3/cw/users/:user_id/profiles/:profile_id/programs/:program_id?is_primary=<value>' \
  --header 'ODK-Service-Name: <string>'

Example Responses

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

json

application/json

Get watch history data by profile

GET

https://cw.odkmedia.io/v3

/wh/users/{user_id}/profiles/{profile_id}

Get watch history data by profile › path Parameters

user_id

integer · required

profile_id

integer · required

Get watch history data by profile › query Parameters

is_primary

bool · enum · required

Enum values:

page_size

number · min: 0 · max: 100

Get watch history data by profile › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Get watch history data by profile › Responses

200

results

Delete watch history data by profile

DELETE

https://cw.odkmedia.io/v3

/wh/users/{user_id}/profiles/{profile_id}

Delete watch history data by profile › path Parameters

user_id

integer · required

profile_id

integer · required

Delete watch history data by profile › query Parameters

is_primary

bool · enum · required

Enum values:

Delete watch history data by profile › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Delete watch history data by profile › Responses

No data returned

Continuous Watching API

Other endpoints

Save continuous watching data

POST

https://cw.odkmedia.io/v3

/cw

Save continuous watching data › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Save continuous watching data › Request Body

SaveContinuousWatching

duration

float · required

episode_id

integer · required

is_primary

boolean · required

last_position

float · required

profile_id

integer · required

program_id

integer · required

session_key

string · required

total_play_time

float · required

user_id

integer · required

Save continuous watching data › Responses

SaveContinuousWatching

duration

float · required

episode_id

integer · required

is_primary

boolean · required

last_position

float · required

profile_id

integer · required

program_id

integer · required

session_key

string · required

total_play_time

float · required

user_id

integer · required

POST/cw

curl https://cw.odkmedia.io/v3/cw \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'ODK-Service-Name: <string>' \
  --data '{
  "duration": 2048.4096,
  "episode_id": 456,
  "is_primary": false,
  "last_position": 512.1204,
  "profile_id": 23,
  "program_id": 123,
  "session_key": null,
  "total_play_time": 1024.2048,
  "user_id": 1
}'

Example Request Body

{
  "duration": 2048.4096,
  "episode_id": 456,
  "is_primary": false,
  "last_position": 512.1204,
  "profile_id": 23,
  "program_id": 123,
  "session_key": null,
  "total_play_time": 1024.2048,
  "user_id": 1
}

json

application/json

Example Responses

{
  "duration": 2048.4096,
  "episode_id": 456,
  "is_primary": false,
  "last_position": 512.1204,
  "profile_id": 23,
  "program_id": 123,
  "session_key": null,
  "total_play_time": 1024.2048,
  "user_id": 1
}

json

application/json

Get continuous watching data by profile

GET

https://cw.odkmedia.io/v3

/cw/users/{user_id}/profiles/{profile_id}

Get continuous watching data by profile › path Parameters

user_id

integer · required

profile_id

integer · required

Get continuous watching data by profile › query Parameters

is_primary

bool · enum · required

Enum values:

page_size

number · min: 0 · max: 100

Get continuous watching data by profile › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Get continuous watching data by profile › Responses

200

results

Get continuous watching data by profile, episode

GET

https://cw.odkmedia.io/v3

/cw/users/{user_id}/profiles/{profile_id}/episodes/{episode_id}

Get continuous watching data by profile, episode › path Parameters

user_id

integer · required

profile_id

integer · required

episode_id

integer · required

Get continuous watching data by profile, episode › query Parameters

is_primary

bool · enum · required

Enum values:

Get continuous watching data by profile, episode › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Get continuous watching data by profile, episode › Responses

200

ContinuousWatchingHistory

Delete watch history data by profile, episode

DELETE

https://cw.odkmedia.io/v3

/cw/users/{user_id}/profiles/{profile_id}/episodes/{episode_id}

Delete watch history data by profile, episode › path Parameters

user_id

integer · required

profile_id

integer · required

episode_id

integer · required

Delete watch history data by profile, episode › query Parameters

is_primary

bool · enum · required

Enum values:

Delete watch history data by profile, episode › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Delete watch history data by profile, episode › Responses

No data returned

Get continuous watching latest episode each program by profile

GET

https://cw.odkmedia.io/v3

/cw/users/{user_id}/profiles/{profile_id}/latest-episode

Get continuous watching latest episode each program by profile › path Parameters

user_id

integer · required

profile_id

integer · required

Get continuous watching latest episode each program by profile › query Parameters

is_primary

bool · enum · required

Enum values:

Get continuous watching latest episode each program by profile › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Get continuous watching latest episode each program by profile › Responses

200

results

GET/cw/users/{user_id}/profiles/{profile_id}/latest-episode

curl 'https://cw.odkmedia.io/v3/cw/users/:user_id/profiles/:profile_id/latest-episode?is_primary=<value>' \
  --header 'ODK-Service-Name: <string>'

Example Responses

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

json

application/json

Get continuous watching data by profile, program

GET

https://cw.odkmedia.io/v3

/cw/users/{user_id}/profiles/{profile_id}/programs/{program_id}

Get continuous watching data by profile, program › path Parameters

user_id

integer · required

profile_id

integer · required

program_id

integer · required

Get continuous watching data by profile, program › query Parameters

is_primary

bool · enum · required

Enum values:

Get continuous watching data by profile, program › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Get continuous watching data by profile, program › Responses

200

results

GET/cw/users/{user_id}/profiles/{profile_id}/programs/{program_id}

curl 'https://cw.odkmedia.io/v3/cw/users/:user_id/profiles/:profile_id/programs/:program_id?is_primary=<value>' \
  --header 'ODK-Service-Name: <string>'

Example Responses

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

json

application/json

Get watch history data by profile

GET

https://cw.odkmedia.io/v3

/wh/users/{user_id}/profiles/{profile_id}

Get watch history data by profile › path Parameters

user_id

integer · required

profile_id

integer · required

Get watch history data by profile › query Parameters

is_primary

bool · enum · required

Enum values:

page_size

number · min: 0 · max: 100

Get watch history data by profile › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Get watch history data by profile › Responses

200

results

Delete watch history data by profile

DELETE

https://cw.odkmedia.io/v3

/wh/users/{user_id}/profiles/{profile_id}

Delete watch history data by profile › path Parameters

user_id

integer · required

profile_id

integer · required

Delete watch history data by profile › query Parameters

is_primary

bool · enum · required

Enum values:

Delete watch history data by profile › Headers

ODK-Service-Name

string · enum · required

Which service

Enum values:

odk

odl

odc

Delete watch history data by profile › Responses

No data returned