Read Takeover and per-screen state

GET

/api/v1/takeovers/{id}

const url = 'https://example.com/api/v1/takeovers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/takeovers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie tilecast_session=<tilecast_session>

Requires an authenticated dashboard user.

Authorizations

sessionCookie
userBearer

Parameters

Path Parameters

required

string format: uuid

Responses

200

Takeover detail

application/json

object

data

required

Takeover detail with the per-screen rollout states. Unlike the list row, the detail carries no aggregate counts.

object

required

string format: uuid

name

required

string

description

required

string

status

required

string

Allowed values: active expired cancelled

playlistId

required

string format: uuid

playlistName

required

string

activatedAt

string | null format: date-time

expiresAt

required

string format: date-time

cancelledAt

string | null format: date-time

cancellationReason

string

screens

required

Array<object>

object

screenId

required

string format: uuid

screenName

required

string

manifestVersion

required

integer format: int64

state

required

string

lastUpdatedAt

required

string format: date-time

failureCode

string | null

failureMessage

string | null

preparedAt

string | null format: date-time

activatedAt

string | null format: date-time

restoredAt

string | null format: date-time

Example

{
  "data": {
    "status": "active"
  }
}

401

Dashboard authentication required

404

Takeover not found