Skip to content
Tilecast Docs

getScreenTelemetry

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

Read a screen’s telemetry. Requires an Owner or Administrator with the read scope.

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
string format: date-time
to
string format: date-time

Responses

Section titled “ Responses ”

200

Section titled “200”

Screen telemetry

Media typeapplication/json
object
data
required
object
range
required
object
from
required
string format: date-time
to
required
string format: date-time
snapshot
required
Any of:
object
observedAt
required
string format: date-time
currentItemId
string
itemStartedAt
string format: date-time
lastMeaningfulProgressAt
string format: date-time
playbackStallDurationMs
integer format: int64
stallReason
string
rendererState
string
rendererResponding
boolean
expectedMotion
boolean
serverRoundTripMs
integer
downloadQueueCount
integer
bytesRemaining
integer format: int64
cacheUsedBytes
integer format: int64
cacheLimitBytes
integer format: int64
freeStorageBytes
integer format: int64
processUptimeSeconds
integer format: int64
deviceUptimeSeconds
integer format: int64
syncGroupDriftMs
integer
frameFingerprint
string
averageLuminance
number
thermalState
string
memoryPressureState
string
networkLinkType
string
wifiSignalDbm
integer
wifiLinkSpeedMbps
integer
gatewayReachable
boolean
captivePortalSuspected
boolean
lastDisconnectReason
string
displayConnected
boolean
displayResolution
string
displayRefreshHz
number
displayPowerState
string
lastShutdownReason
string
powerSource
string
batteryPercent
integer
<= 100
clockOffsetSeconds
integer
timeSyncState
string
startupTotalMs
integer format: int64
startupConfigMs
integer format: int64
startupManifestMs
integer format: int64
startupAssetVerifyMs
integer format: int64
startupFirstFrameMs
integer format: int64
videoDecoderPath
string
videoDecodedResolution
string
conditions
required
Array<object>
object
condition
required
string
active
required
boolean
enteredAt
string format: date-time
exitedAt
string format: date-time
occurrenceCount
required
integer format: int64
rollups
required
Array<object>
object
bucketStart
required
string format: date-time
samples
required
integer
averageRoundTripMs
number
maxRoundTripMs
integer
connectedSeconds
required
integer
disconnectedSeconds
required
integer
healthyPlaybackSeconds
required
integer
stalledPlaybackSeconds
required
integer
blackOutputSeconds
required
integer
droppedFrames
required
integer format: int64
frameChangeCount
required
integer format: int64
downloadedBytes
required
integer format: int64
cacheHits
required
integer format: int64
cacheMisses
required
integer format: int64
averageMemoryBytes
integer format: int64
peakMemoryBytes
integer format: int64
averageCpuPercent
number
<= 100
thermalDistribution
required
object
key
additional properties
number
syncDriftP50Ms
integer
syncDriftP95Ms
integer
syncDriftMaxMs
integer
httpRequestCount
required
integer format: int64
httpFailureCount
required
integer format: int64
httpClientErrorCount
required
integer format: int64
httpServerErrorCount
required
integer format: int64
requestRetryCount
required
integer format: int64
socketReconnectCount
required
integer format: int64
networkInterfaceChangeCount
required
integer format: int64
dnsResolveP95Ms
integer
tlsHandshakeP95Ms
integer
timeToFirstByteP95Ms
integer
averageThroughputBytesPerSecond
integer format: int64
frameTimeP95Ms
number
frameTimeP99Ms
number
jankFrameCount
required
integer format: int64
rendererCrashCount
required
integer format: int64
surfaceLostCount
required
integer format: int64
decoderInitFailureCount
required
integer format: int64
cacheEvictionCount
required
integer format: int64
cacheEvictedBytes
required
integer format: int64
integrityFailureCount
required
integer format: int64
downloadResumeCount
required
integer format: int64
downloadFailureCount
required
integer format: int64
unexpectedRebootCount
required
integer format: int64
displaySleepCount
required
integer format: int64
displayWakeCount
required
integer format: int64
Examplegenerated
{
  "data": {
    "range": {
      "from": "2026-04-15T12:00:00Z",
      "to": "2026-04-15T12:00:00Z"
    },
    "snapshot": {
      "observedAt": "2026-04-15T12:00:00Z",
      "currentItemId": "example",
      "itemStartedAt": "2026-04-15T12:00:00Z",
      "lastMeaningfulProgressAt": "2026-04-15T12:00:00Z",
      "playbackStallDurationMs": 1,
      "stallReason": "example",
      "rendererState": "example",
      "rendererResponding": true,
      "expectedMotion": true,
      "serverRoundTripMs": 1,
      "downloadQueueCount": 1,
      "bytesRemaining": 1,
      "cacheUsedBytes": 1,
      "cacheLimitBytes": 1,
      "freeStorageBytes": 1,
      "processUptimeSeconds": 1,
      "deviceUptimeSeconds": 1,
      "syncGroupDriftMs": 1,
      "frameFingerprint": "example",
      "averageLuminance": 1,
      "thermalState": "example",
      "memoryPressureState": "example",
      "networkLinkType": "example",
      "wifiSignalDbm": 1,
      "wifiLinkSpeedMbps": 1,
      "gatewayReachable": true,
      "captivePortalSuspected": true,
      "lastDisconnectReason": "example",
      "displayConnected": true,
      "displayResolution": "example",
      "displayRefreshHz": 1,
      "displayPowerState": "example",
      "lastShutdownReason": "example",
      "powerSource": "example",
      "batteryPercent": 1,
      "clockOffsetSeconds": 1,
      "timeSyncState": "example",
      "startupTotalMs": 1,
      "startupConfigMs": 1,
      "startupManifestMs": 1,
      "startupAssetVerifyMs": 1,
      "startupFirstFrameMs": 1,
      "videoDecoderPath": "example",
      "videoDecodedResolution": "example"
    },
    "conditions": [
      {
        "condition": "example",
        "active": true,
        "enteredAt": "2026-04-15T12:00:00Z",
        "exitedAt": "2026-04-15T12:00:00Z",
        "occurrenceCount": 1
      }
    ],
    "rollups": [
      {
        "bucketStart": "2026-04-15T12:00:00Z",
        "samples": 1,
        "averageRoundTripMs": 1,
        "maxRoundTripMs": 1,
        "connectedSeconds": 1,
        "disconnectedSeconds": 1,
        "healthyPlaybackSeconds": 1,
        "stalledPlaybackSeconds": 1,
        "blackOutputSeconds": 1,
        "droppedFrames": 1,
        "frameChangeCount": 1,
        "downloadedBytes": 1,
        "cacheHits": 1,
        "cacheMisses": 1,
        "averageMemoryBytes": 1,
        "peakMemoryBytes": 1,
        "averageCpuPercent": 1,
        "thermalDistribution": {
          "additionalProperty": 1
        },
        "syncDriftP50Ms": 1,
        "syncDriftP95Ms": 1,
        "syncDriftMaxMs": 1,
        "httpRequestCount": 1,
        "httpFailureCount": 1,
        "httpClientErrorCount": 1,
        "httpServerErrorCount": 1,
        "requestRetryCount": 1,
        "socketReconnectCount": 1,
        "networkInterfaceChangeCount": 1,
        "dnsResolveP95Ms": 1,
        "tlsHandshakeP95Ms": 1,
        "timeToFirstByteP95Ms": 1,
        "averageThroughputBytesPerSecond": 1,
        "frameTimeP95Ms": 1,
        "frameTimeP99Ms": 1,
        "jankFrameCount": 1,
        "rendererCrashCount": 1,
        "surfaceLostCount": 1,
        "decoderInitFailureCount": 1,
        "cacheEvictionCount": 1,
        "cacheEvictedBytes": 1,
        "integrityFailureCount": 1,
        "downloadResumeCount": 1,
        "downloadFailureCount": 1,
        "unexpectedRebootCount": 1,
        "displaySleepCount": 1,
        "displayWakeCount": 1
      }
    ]
  }
}

401

Section titled “401”

Dashboard authentication required

403

Section titled “403”

Insufficient role