curation

curation retrieve

GET

https://odkmedia.io/odx/api/v2

/curation/{slug}/

The slug of ODK home carousels: home-curation-default

curation retrieve › path Parameters

slug

string · required

curation retrieve › query Parameters

debug

string

If value is "on", debug is included in response.

curation retrieve › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

curation retrieve › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2Curation

GET/curation/{slug}/

curl https://odkmedia.io/odx/api/v2/curation/:slug \
  --header 'Service-Name: <string>' \
  --header 'Authorization: <api-key>'

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "contents": [
      {
        "logic_category": 0,
        "logic_ordering": "episode-recent-updated",
        "manual_ids": [
          0
        ],
        "max": 0,
        "program_direct_play": true,
        "ratio": "portrait",
        "slug": "slug",
        "title": "title",
        "title_url": "title_url",
        "type": "episode",
        "carousels": [
          {
            "age_rating": {},
            "badges": {
              "bottom_left": "content-new-episode",
              "bottom_right": "bottom_right",
              "top_left": "content-premium",
              "top_right": "content-live"
            },
            "id": 0,
            "images": {
              "thumbnail": "https://www.example.com/path/to/resource"
            },
            "kind": "series",
            "number": 0,
            "part": 0,
            "program": {
              "id": 0,
              "images": {
                "poster": "https://www.example.com/path/to/resource",
                "poster_landscape": "https://www.example.com/path/to/resource",
                "poster_portrait": "https://www.example.com/path/to/resource"
              },
              "slug": "slug",
              "title": "title",
              "categories": [
                {
                  "id": 0,
                  "slug": "slug",
                  "title": "title"
                }
              ]
            },
            "title": "title",
            "video": "video",
            "video_cc_languages": [
              "ko"
            ]
          }
        ],
        "cover": {
          "image": "https://image-url.com",
          "tracking": "https://tracking-url.com",
          "url": "https://test.com"
        }
      }
    ],
    "id": 0,
    "service_name": "odk",
    "slug": "slug"
  }
}

json

application/json

curation content list

GET

https://odkmedia.io/odx/api/v2

/curation/{slug}/contents/

This API returns curation contents without carousel items.
The slug of ODK home carousels: home-curation-default

curation content list › path Parameters

slug

string · required

curation content list › query Parameters

debug

string

If value is "on", debug is included in response.

curation content list › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

curation content list › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2CurationWithoutCarousels

GET/curation/{slug}/contents/

curl https://odkmedia.io/odx/api/v2/curation/:slug/contents \
  --header 'Service-Name: <string>' \
  --header 'Authorization: <api-key>'

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "contents": [
      "popular-movie"
    ],
    "id": 0,
    "service_name": "odk",
    "slug": "slug"
  }
}

json

application/json

curation content retrieve

GET

https://odkmedia.io/odx/api/v2

/curation/{slug}/contents/{content_slug}/

This API returns only 1 carousel in contents field that is requested with a content_slug.
The slug of ODK home carousels: home-curation-default

curation content retrieve › path Parameters

slug

string · required

curation content retrieve › query Parameters

debug

string

If value is "on", debug is included in response.

curation content retrieve › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

curation content retrieve › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2CurationContentRetrieve

GET/curation/{slug}/contents/{content_slug}/

curl https://odkmedia.io/odx/api/v2/curation/:slug/contents/:content_slug \
  --header 'Service-Name: <string>' \
  --header 'Authorization: <api-key>'

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "contents": {
      "logic_category": 0,
      "logic_ordering": "episode-recent-updated",
      "manual_ids": [
        0
      ],
      "max": 0,
      "program_direct_play": true,
      "ratio": "portrait",
      "slug": "slug",
      "title": "title",
      "title_url": "title_url",
      "type": "episode",
      "carousels": [
        {
          "age_rating": {},
          "badges": {
            "bottom_left": "content-new-episode",
            "bottom_right": "bottom_right",
            "top_left": "content-premium",
            "top_right": "content-live"
          },
          "id": 0,
          "images": {
            "thumbnail": "https://www.example.com/path/to/resource"
          },
          "kind": "series",
          "number": 0,
          "part": 0,
          "program": {
            "id": 0,
            "images": {
              "poster": "https://www.example.com/path/to/resource",
              "poster_landscape": "https://www.example.com/path/to/resource",
              "poster_portrait": "https://www.example.com/path/to/resource"
            },
            "slug": "slug",
            "title": "title",
            "categories": [
              {
                "id": 0,
                "slug": "slug",
                "title": "title"
              }
            ]
          },
          "title": "title",
          "video": "video",
          "video_cc_languages": [
            "ko"
          ]
        }
      ],
      "cover": {
        "image": "https://image-url.com",
        "tracking": "https://tracking-url.com",
        "url": "https://test.com"
      }
    },
    "id": 0,
    "service_name": "odk",
    "slug": "slug"
  }
}

json

application/json

cover epg

curation retrieve

GET

https://odkmedia.io/odx/api/v2

/curation/{slug}/

The slug of ODK home carousels: home-curation-default

curation retrieve › path Parameters

slug

string · required

curation retrieve › query Parameters

debug

string

If value is "on", debug is included in response.

curation retrieve › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

curation retrieve › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2Curation

curation content list

GET

https://odkmedia.io/odx/api/v2

/curation/{slug}/contents/

This API returns curation contents without carousel items.
The slug of ODK home carousels: home-curation-default

curation content list › path Parameters

slug

string · required

curation content list › query Parameters

debug

string

If value is "on", debug is included in response.

curation content list › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

curation content list › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2CurationWithoutCarousels

curation content retrieve

GET

https://odkmedia.io/odx/api/v2

/curation/{slug}/contents/{content_slug}/

This API returns only 1 carousel in contents field that is requested with a content_slug.
The slug of ODK home carousels: home-curation-default

curation content retrieve › path Parameters

slug

string · required

curation content retrieve › query Parameters

debug

string

If value is "on", debug is included in response.

curation content retrieve › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

curation content retrieve › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2CurationContentRetrieve