JWjwplayer
App Config

App Config

Get config JSON object for an App Config

get/apps/configs/{config_id}.json

Request

  • Base URL
    https://cdn.jwplayer.com
  • URL
    https://cdn.jwplayer.com/apps/configs/{config_id}.json
  • Auth
    none declared

Path parameters

config_idstring string required

Response

A JSON object describing an App Config object.

ad_schedulestring

Eight-character, alphanumeric ID of an ad schedule

analytics_tokenstring

Unique ID for analytics associated with a site

customobject

Use this object to set custom properties

descriptionstring

Short description of the type of content in the App Config This description is used for SEO.

playerstring

Eight-character, alphanumeric player ID to use with the App Config

site_namestring

Title displayed in the <title> tag of the App Config

Example response

{
  "ad_schedule": "5wRT89gf",
  "analytics_token": "lDdMCg7E_euMinvqc5Jccw",
  "assets": {
    "banner": "https://cdn.jwplayer.com/images/nwthWC1U.png"
  },
  "content": [
    {
      "background_color": "#FF0000",
      "content_id": "1q2w3e4r",
      "enable_text": true,
      "featured": true,
      "title": "Awesome Movies",
      "type": "playlist"
    }
  ],
  "custom": {
    "yourKey": "yourValue",
    "foo": "BAR"
  },
  "description": "1q2w3e4r",
  "features": {
    "enable_casting": true,
    "enable_sharing": true,
    "continue_watching_list": "1q2w3e4r",
    "favorites_list": "1q2w3e4r",
    "recommendations_playlist": "1q2w3e4r",
    "search_playlist": "1q2w3e4r"
  },
  "integrations": {
    "cleeng": {
      "id": "addsfjadsfadfasdfasas",
      "monthly_offer": "S345534153_NL",
      "yearly_offer": "S346369153_NL",
      "use_sandbox": true
    }
  },
  "menu": [
    {
      "content_id": "a1B2cDEF",
      "label": "All Movies",
      "filter_tags": "Action,Comedy,Drama,Sci-Fi",
      "type": "playlist"
    }
  ],
  "player": "1q2w3e4r",
  "site_name": "Street food and the world",
  "styling": {
    "background_color": "#FF0000",
    "header_background": "#1a1a1a",
    "highlight_color": "FF0000",
    "poster_fading": true,
    "shelf_titles": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.