listIncidents

GET

/api/v1/activity/incidents

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

Requires an authenticated user with the read scope. Incident list newest first, defaulting to active incidents. status accepts open, acknowledged, recovered, resolved, ignored, and all; severity accepts info, warning, error, and critical; type accepts connectivity, playback, storage, safe-mode, and update.

Authorizations

sessionCookie
userBearer

Parameters

Query Parameters

status

string

severity

string

type

string

screen

string format: uuid

group

string format: uuid

location

string format: uuid

assignee

string format: uuid

failureCode

string

search

string

from

string format: date-time

dateBasis

string

Allowed values: opened recovered resolved

Responses

200

Incident list

application/json

object

data

required

object

items

required

Array<object>

object

required

string format: uuid

incidentType

required

string

Allowed values: connectivity playback storage safe-mode update

severity

required

string

Allowed values: info warning error critical

status

required

string

Allowed values: open acknowledged recovered resolved ignored

title

required

string

description

required

string

openedAt

required

string format: date-time

lastSeenAt

required

string format: date-time

recoveredAt

string format: date-time

resolvedAt

string format: date-time

acknowledgedAt

string format: date-time

acknowledgedBy

string

assignedTo

string format: uuid

assignedToName

string

primaryScreenId

string format: uuid

primaryScreenName

string

locationName

string

groupName

string

deviceModel

string

playerVersion

string

affectedScreens

required

integer

failureCode

string

probableCause

string

recoveryMode

string

resolutionReason

string

resolutionNotes

string

relatedType

string

relatedId

string

occurrenceCount

required

integer

Example

{
  "data": {
    "items": [
      {
        "incidentType": "connectivity",
        "severity": "info",
        "status": "open"
      }
    ]
  }
}

401

Dashboard authentication required

422

Incident_status_invalid