Skip to content
Tilecast Docs

getProofOfPlaySummary

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

Summarize Player-confirmed proof of play by dimension. Requires an authenticated dashboard user with the read scope.

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
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

Section titled “ Responses ”

200

Section titled “200”

Proof-of-play summary

Media typeapplication/json
object
data
required
object
dimension
required
string
items
required
Array<object>
object
key
required
string
label
required
string
confirmedScreenPlaybackMs
required
integer format: int64
contentExposureMs
required
integer format: int64
records
required
integer format: int64
completed
required
integer format: int64
failures
required
integer format: int64
partial
required
integer format: int64
unknown
required
integer format: int64
interrupted
required
integer format: int64
sessionCompletionPercent
required
number
<= 100
Examplegenerated
{
  "data": {
    "dimension": "example",
    "items": [
      {
        "key": "example",
        "label": "example",
        "confirmedScreenPlaybackMs": 1,
        "contentExposureMs": 1,
        "records": 1,
        "completed": 1,
        "failures": 1,
        "partial": 1,
        "unknown": 1,
        "interrupted": 1,
        "sessionCompletionPercent": 1
      }
    ]
  }
}

401

Section titled “401”

Dashboard authentication required

422

Section titled “422”

Range or proof filter invalid