List Takeovers

GET

/api/v1/takeovers

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

Requires an authenticated dashboard user.

Authorizations

sessionCookie
userBearer

Responses

200

Takeover list

application/json

object

data

required

object

items

required

Array<object>

Compact takeover row returned by the takeover list, with live per-state screen counts. The per-screen breakdown requires the detail read.

object

required

string format: uuid

name

required

string

description

required

string

playlistId

required

string format: uuid

playlistName

required

string

status

required

string

Allowed values: active expired cancelled

activatedAt

string | null format: date-time

expiresAt

required

string format: date-time

cancelledAt

string | null format: date-time

cancellationReason

string

affectedCount

required

integer

activeCount

required

integer

preparingCount

required

integer

failedCount

required

integer

total

required

integer

Example

{
  "data": {
    "items": [
      {
        "status": "active"
      }
    ]
  }
}

401

Dashboard authentication required