getScreenActivity

GET

/api/v1/activity/screens/{id}

curl --request GET \
  --url https://example.com/api/v1/activity/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie tilecast_session=<tilecast_session>

Read a screen’s activity. Requires an authenticated dashboard user with the read scope.

Authorizations

• sessionCookie
• userBearer

Parameters

Path Parameters

id

required

string format: uuid

Query Parameters

from

string format: date-time

to

string format: date-time

Responses

200

Screen activity

Media typeapplication/json

object

data

required

object

screenId

required

string format: uuid

currentPresentation

The most recent Player-confirmed presentation record. Absent when the Screen has not confirmed one.

object

id

required

string format: uuid

startedAt

required

string format: date-time

endedAt

string format: date-time

screenId

required

string format: uuid

screenName

required

string

groupId

string format: uuid

groupName

string

presentationType

string

presentationId

string

presentationRevision

string

presentationName

string

contentType

string

contentId

string

contentName

string

playlistItemId

string

layoutPlacementId

string

actualDurationMs

integer format: int64

expectedDurationMs

integer format: int64

result

required

string

Allowed values: playing completed partial skipped failed unknown recovered success

trigger

string

scheduleId

string

takeoverId

string

manifestVersion

integer format: int64

failureCode

string

sourceId

string

selectedRecordId

string

selectionDate

string format: date-time

sourceCachedAt

string format: date-time

sourceRevision

string

snapshotHash

string

sessionType

required

string

Allowed values: presentation content layout_placement playlist_item

terminalReason

string

Allowed values: expected_item_boundary completed_duration schedule_transition manifest_replacement direct_assignment_change takeover manual_skip empty_content player_restart process_exit heartbeat_gap renderer_failure decoder_failure recovery_action bounded_timeout unknown

details

required

Allowlisted event metadata, filtered for the caller’s role. Sensitive values stay server-side.

object

key

additional properties

any

recentProofOfPlay

required

Array<object>

object

id

required

string format: uuid

startedAt

required

string format: date-time

endedAt

string format: date-time

screenId

required

string format: uuid

screenName

required

string

groupId

string format: uuid

groupName

string

presentationType

string

presentationId

string

presentationRevision

string

presentationName

string

contentType

string

contentId

string

contentName

string

playlistItemId

string

layoutPlacementId

string

actualDurationMs

integer format: int64

expectedDurationMs

integer format: int64

result

required

string

Allowed values: playing completed partial skipped failed unknown recovered success

trigger

string

scheduleId

string

takeoverId

string

manifestVersion

integer format: int64

failureCode

string

sourceId

string

selectedRecordId

string

selectionDate

string format: date-time

sourceCachedAt

string format: date-time

sourceRevision

string

snapshotHash

string

sessionType

required

string

Allowed values: presentation content layout_placement playlist_item

terminalReason

string

Allowed values: expected_item_boundary completed_duration schedule_transition manifest_replacement direct_assignment_change takeover manual_skip empty_content player_restart process_exit heartbeat_gap renderer_failure decoder_failure recovery_action bounded_timeout unknown

details

required

Allowlisted event metadata, filtered for the caller’s role. Sensitive values stay server-side.

object

key

additional properties

any

recentEvents

required

Array<object>

object

id

required

string format: uuid

timestamp

required

string format: date-time

receivedAt

required

string format: date-time

screenId

required

string format: uuid

screenName

required

string

groupId

string format: uuid

groupName

string

sequence

required

Player sequence, monotonic per device. Null for server-derived transitions, which have no device queue position.

integer | null format: int64

eventType

required

string

category

required

string

Allowed values: connectivity manifest playback scheduling commands reliability updates takeovers system

severity

required

string

Allowed values: debug info warning error critical

description

required

string

relatedType

string

relatedId

string

result

required

string

Allowed values: playing completed partial skipped failed unknown recovered success

manifestVersion

integer format: int64

failureCode

string

failureMessage

string

details

required

Allowlisted event metadata, filtered for the caller’s role. Sensitive values stay server-side.

object

key

additional properties

any

playbackGaps

required

integer

lastHealthyPlayback

string format: date-time

lastSuccessfulManifestActivation

string format: date-time

currentIssue

object

screenId

required

string format: uuid

screenName

required

string

kind

required

string

severity

required

string

description

required

string

occurredAt

required

string format: date-time

Example

{
  "data": {
    "currentPresentation": {
      "result": "playing",
      "sessionType": "presentation",
      "terminalReason": "expected_item_boundary"
    },
    "recentProofOfPlay": [
      {
        "result": "playing",
        "sessionType": "presentation",
        "terminalReason": "expected_item_boundary"
      }
    ],
    "recentEvents": [
      {
        "category": "connectivity",
        "severity": "debug",
        "result": "playing"
      }
    ]
  }
}

401

Dashboard authentication required