listProofOfPlay

GET

/api/v1/activity/proof-of-play

const url = 'https://example.com/api/v1/activity/proof-of-play?sessionType=presentation&terminalReason=expected_item_boundary';
const options = {method: 'GET', headers: {cookie: 'tilecast_session=<tilecast_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/activity/proof-of-play?sessionType=presentation&terminalReason=expected_item_boundary' \
  --cookie tilecast_session=<tilecast_session>

List Player-confirmed proof-of-play records. Requires an authenticated dashboard user with the read scope.

Authorizations

sessionCookie
userBearer

Parameters

Query Parameters

from

string format: date-time

page

integer

>= 1

pageSize

integer

>= 1 <= 100

cursor

string

screen

string format: uuid

group

string format: uuid

result

string

sessionType

string

Allowed values: presentation content layout_placement playlist_item

terminalReason

A terminal reason, or unexpected, which matches every interrupted reason the Interrupted plays metric counts.

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 unexpected

media

string

widget

string

content

string

playlist

string

layout

string

schedule

string

takeover

string

search

string

Responses

200

Proof-of-play records

application/json

object

data

required

object

items

required

Array<object>

object

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

details

required

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

object

key

additional properties

any

nextCursor

string

Example

{
  "data": {
    "items": [
      {
        "result": "playing",
        "sessionType": "presentation",
        "terminalReason": "expected_item_boundary"
      }
    ]
  }
}

401

Dashboard authentication required

422

Range, page, or proof filter invalid