Skip to content
Tilecast Docs

getPlaybackCompliance

GET
/api/v1/activity/compliance
curl --request GET \
  --url 'https://example.com/api/v1/activity/compliance?dimension=screen' \
  --cookie tilecast_session=<tilecast_session>

Requires an authenticated user with the read scope. Expected-versus-actual playback compliance for a time window, cut by dimension (screen, location, group, presentation, schedule, date, or reason; defaults to screen). from and to are RFC 3339 timestamps defaulting to the last 24 hours.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
from
string format: date-time
to
string format: date-time
dimension
string
Allowed values: screen location group presentation schedule date reason

Responses

Section titled “ Responses ”

200

Section titled “200”

Playback compliance report

Media typeapplication/json
object
data
required
object
range
required
object
from
required
string format: date-time
to
required
string format: date-time
measurableExpectedMs
required
integer format: int64
confirmedMs
required
integer format: int64
missedMs
required
integer format: int64
compliancePercent
required
number | null
<= 100
takeoverOverriddenMs
required
integer format: int64
cancelledMs
required
integer format: int64
notMeasurableMs
required
integer format: int64
windows
required
integer format: int64
lateStarts
required
integer format: int64
earlyEndings
required
integer format: int64
neverStarted
required
integer format: int64
offlineMisses
required
integer format: int64
failedWindows
required
integer format: int64
partialWindows
required
integer format: int64
breakdown
required
Array<object>
object
key
required
string
label
required
string
measurableExpectedMs
required
integer format: int64
confirmedMs
required
integer format: int64
missedMs
required
integer format: int64
compliancePercent
required
number | null
<= 100
windows
required
integer format: int64
lateStarts
required
integer format: int64
earlyEndings
required
integer format: int64
neverStarted
required
integer format: int64
offlineMisses
required
integer format: int64
topFailureReason
string
dimension
required
string
Allowed values: screen location group presentation schedule date reason
Example
{
  "data": {
    "dimension": "screen"
  }
}

401

Section titled “401”

Dashboard authentication required

422

Section titled “422”

Activity_range_invalid