Schedules represent availability during a given time period, for a given set of dimensions.

The available dimensions are Affiliate, Device Type, Language, Locale, and Region. The values of each dimension are represented by a slug and a free text name. The endpoints under /api/dimensions/ allow these to be retrieved and managed.

A full description of Scheduling across the API is given in the Scheduling section.

The API always returns three fields with that contains information about the schedules associated with the prepared object :

  • schedule_url (deprecated): returns the url of a arbitrary chose schedule
  • schedule_urls: returns the urls for all the schedules associated with the object
  • schedule_statuses: for each schedule associated with the object, indicate if it matches the current request parameters