List active Quick Present sessions

GET

/api/v1/presentation-overrides

const url = 'https://example.com/api/v1/presentation-overrides';
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/presentation-overrides \
  --cookie tilecast_session=<tilecast_session>

Requires an authenticated dashboard user.

Authorizations

sessionCookie
userBearer

Responses

200

Active temporary presentation overrides

application/json

object

data

required

object

items

required

Array<object>

Active Quick Present session. The stopped timestamp and reason appear once the session ends.

object

required

string format: uuid

targetType

required

string

Allowed values: screen group

targetId

required

string format: uuid

targetName

required

string

contentType

required

string

Allowed values: playlist layout asset

contentId

required

string format: uuid

contentName

required

string

durationSeconds

required

integer

startedAt

required

string format: date-time

expiresAt

string format: date-time

afterAction

required

string

Allowed values: resume

wakeDisplay

required

boolean

stoppedAt

string format: date-time

stopReason

string

total

required

integer

Example

{
  "data": {
    "items": [
      {
        "targetType": "screen",
        "contentType": "playlist",
        "afterAction": "resume"
      }
    ]
  }
}

401

Dashboard authentication required