getIncident

GET

/api/v1/activity/incidents/{id}

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

Requires an authenticated user with the read scope. One incident with its timeline and affected screens.

Authorizations

• sessionCookie
• userBearer

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Incident detail with timeline

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

incidentType

required

string

Allowed values: connectivity playback storage safe-mode update

severity

required

string

Allowed values: info warning error critical

status

required

string

Allowed values: open acknowledged recovered resolved ignored

title

required

string

description

required

string

openedAt

required

string format: date-time

lastSeenAt

required

string format: date-time

recoveredAt

string format: date-time

resolvedAt

string format: date-time

acknowledgedAt

string format: date-time

acknowledgedBy

string

assignedTo

string format: uuid

assignedToName

string

primaryScreenId

string format: uuid

primaryScreenName

string

locationName

string

groupName

string

deviceModel

string

playerVersion

string

affectedScreens

required

integer

failureCode

string

probableCause

string

recoveryMode

string

resolutionReason

string

resolutionNotes

string

relatedType

string

relatedId

string

occurrenceCount

required

integer

timeline

required

Array<object>

object

id

required

string format: uuid

role

required

string

occurredAt

required

string format: date-time

actorName

string

summary

required

string

screens

required

Array<object>

object

screenId

required

string format: uuid

screenName

required

string

relatedEvents

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

proofSessions

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

auditChanges

required

Array<object>

object

id

required

string format: uuid

timestamp

required

string format: date-time

actorId

string format: uuid

actorName

required

string

actorUsername

string

action

required

string

resourceType

required

string

resourceId

string

resourceName

string

result

required

string

ipAddress

string

requestId

string

summary

required

string

metadata

required

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

object

key

additional properties

any

recoveryPath

required

string

Example

{
  "data": {
    "incidentType": "connectivity",
    "severity": "info",
    "status": "open",
    "relatedEvents": [
      {
        "category": "connectivity",
        "severity": "debug",
        "result": "playing"
      }
    ],
    "proofSessions": [
      {
        "result": "playing",
        "sessionType": "presentation",
        "terminalReason": "expected_item_boundary"
      }
    ]
  }
}

401

Dashboard authentication required

404

Incident_not_found