demoState

GET

/api/v1/demo

const url = 'https://example.com/api/v1/demo';
const options = {method: 'GET'};

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

Registered only when TILECAST_ENV is demo. Returns the seeded scenario and the state of each simulated player.

Responses

200

Demo scenario and simulated player state

application/json

object

data

required

object

scenario

required

string

Allowed values: basic kitchen-sink

scenarios

required

Array<string>

seededAt

required

string format: date-time

players

required

Array<object>

object

screenId

required

string format: uuid

screenName

required

string

transport

required

string

Allowed values: heartbeat socket

connected

required

boolean

manifestVersion

required

integer format: int64

manifestFetches

required

integer

commandsHandled

required

integer

lastCommand

string

lastError

string

Example

{
  "data": {
    "scenario": "basic",
    "players": [
      {
        "transport": "heartbeat"
      }
    ]
  }
}

401

Authentication required