Skip to content
Tilecast Docs

getScreenPlaybackAgenda

GET
/api/v1/screens/{id}/playback-agenda
curl --request GET \
  --url 'https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/playback-agenda?from=2026-04-15T12%3A00%3A00Z&to=2026-04-15T12%3A00%3A00Z' \
  --cookie tilecast_session=<tilecast_session>

Forecast expected presentation selection for a Screen. Requires the read scope and access to the Screen. Uses one current-configuration snapshot. Clips elapsed time to server time. Each segment includes its start and excludes its end. It does not report readiness or observed playback.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
from
required
string format: date-time
to
required
string format: date-time

Responses

Section titled “ Responses ”

200

Section titled “200”

Expected playback segments, empty when the range has elapsed

Media typeapplication/json
object
data
required
object
evaluatedAt
required
string format: date-time
segments
required
Array<object>
object
start
required
string format: date-time
end
required
string format: date-time
selected
object
source
required
string
Allowed values: takeover quick_present schedule assignment
contentType
required
string
Allowed values: playlist layout asset
contentId
required
string format: uuid
name

Current selected content name; absent for a missing resource.

string
scheduleName

Current selected schedule name, when a schedule selects the content.

string
selectionId
string format: uuid
revision

Current playlist or published Layout revision; absent for assets, missing resources, and unpublished Layouts.

integer format: int64
reason
required
string
Allowed values: active_takeover active_quick_present assigned_fallback schedule_highest_precedence schedule_disabled schedule_not_active schedule_lower_priority schedule_less_specific schedule_earlier_start schedule_stable_id_tiebreak no_active_takeover no_active_quick_present no_assignment
superseded
required

Active schedules that did not select playback during this segment.

Array<object>
object
source
required
string
Allowed values: takeover quick_present schedule assignment
id
string format: uuid
status
required
string
Allowed values: selected superseded inactive
reason
required
string
Allowed values: active_takeover active_quick_present assigned_fallback schedule_highest_precedence schedule_disabled schedule_not_active schedule_lower_priority schedule_less_specific schedule_earlier_start schedule_stable_id_tiebreak no_active_takeover no_active_quick_present no_assignment
scheduleReason
string
Allowed values: active_takeover active_quick_present assigned_fallback schedule_highest_precedence schedule_disabled schedule_not_active schedule_lower_priority schedule_less_specific schedule_earlier_start schedule_stable_id_tiebreak no_active_takeover no_active_quick_present no_assignment
name

Current schedule candidate name, when available.

string
schedule

Scheduling authority evidence remains available when a temporary presentation supersedes the schedule.

object
scheduleId
required
string format: uuid
status
required
string
Allowed values: selected superseded inactive
reason
required
string
Allowed values: active_takeover active_quick_present assigned_fallback schedule_highest_precedence schedule_disabled schedule_not_active schedule_lower_priority schedule_less_specific schedule_earlier_start schedule_stable_id_tiebreak no_active_takeover no_active_quick_present no_assignment
priority
required
integer
specificity
required
integer
start
string format: date-time
end
string format: date-time
Example
{
  "data": {
    "segments": [
      {
        "selected": {
          "source": "takeover",
          "contentType": "playlist",
          "reason": "active_takeover"
        },
        "superseded": [
          {
            "source": "takeover",
            "status": "selected",
            "reason": "active_takeover",
            "scheduleReason": "active_takeover",
            "schedule": {
              "status": "selected",
              "reason": "active_takeover"
            }
          }
        ]
      }
    ]
  }
}

400

Section titled “400”

Invalid or duplicate parameters or range longer than eight days

401

Section titled “401”

Management authentication required

403

Section titled “403”

Grant lacks the read scope

404

Section titled “404”

Screen unavailable or outside account scope

422

Section titled “422”

Range contains too many schedule boundaries