Get all incidents in a home

GET/homes/{homeId}/smartModules/{moduleId}/incidents

Base URL: https://api.tinkermode.com

Get the list of all incidents in this home.

Authentication

This endpoint does not require authentication.

Path parameters

Name	Type	Required	Constraints	Description
`homeId`	integer	Yes		The unique id for a home.
`moduleId`	string	Yes		The unique id for a smart module.

Query parameters

Name	Type	Required	Constraints	Description
`limit`	integer	No	default: 20; min: 1; max: 100	If non-zero, maximum number of incidents to return. limit should be the number between 1 to 100.
`monitorId`	number	No		ID of monitor by which this incident is created
`skip`	integer	No	default: 0; min: 0	Number of incidents to skip over (incidents are ordered in descending order by creation time)

Responses

`200` An array of monitors are returned.

Content type: application/json

Incident that is created by monitor

An array of objects with the following shape:

Property Type Required Constraints Description

creationTime string No read-only (server-generated) Timestamp of creation of this incident.

description string No read-only (server-generated) Description of this incident

evaluationTimeRange unknown No

homeId integer No read-only (server-generated) Home that this monitor belongs to

incidentType string No read-only (server-generated); one of: alert, recovery Type of this incident

moduleId string No read-only (server-generated) Smart Module that this incident belongs to

monitorId integer No read-only (server-generated) Monitor that created this incident

monitorSnapshot object No Snapshot of the monitor which is to be created when the incident is created

Property Type Required Constraints Description

condition one of 2 No read-only (server-generated) Monitor Condition object

One of the following 2 shapes:

Variant 1

Heartbeat monitoring condition against data points in a time series.

Property	Type	Required	Description
`conditionType`	string	Yes	Currently, the only supported type is `timeSeriesHeartbeat`.
`interval`	integer	Yes	Duration of time (second) how often data points are expected to appear in the time series. It should be longer than 60 seconds at least.
`seriesId`	string	Yes	Time Series ID to be monitored.

Variant 2

Threshold-based monitoring condition against static data points in a time series

Property	Type	Required	Constraints	Description
`conditionType`	string	Yes		Currently, the only supported type is `timeSeriesThreshold`
`dataPointsDuration`	integer	Yes		Expected duration of time (in seconds) between two data points
`dataPointsEvaluationPolicy`	string	Yes	one of: consecutive, total	How to count the breaching data points
`interval`	integer	Yes		How often (in seconds) the monitoring condition is evaluated
`missingDataPointPolicy`	string	Yes	one of: ignore, breaching, notBreaching	How to treat missing data
`numberOfBreachingDataPointsToAlert`	integer	Yes		Number of breaching data points before an alert is triggered
`operator`	string	Yes	one of: lessThan, lessThanOrEqualTo, equal, notEqual, greaterThanOrEqualTo, greaterThan	The operator to compare the threshold value and monitored value
`seriesId`	string	Yes		Time Series ID to be monitored
`threshold`	number	Yes		Threshold value against which the monitor evaluates whether the data point has breached the condition

description string No Monitor description

evaluationDelay integer No read-only (server-generated) How long the monitor evaluation should be delayed

incidentCustomDescriptions object No User defined incident descriptions

Properties of incidentCustomDescriptions
Property	Type	Required	Constraints	Description
`alert`	string	No	read-only (server-generated)	Custom description for alert incident. If not set, default description will be 'ALERT: ${monitor.name}'
`recovery`	string	No	read-only (server-generated)	Custom description for recovery incident. If not set, default description will be 'RECOVERY: ${monitor.name}'

name string No Monitor name

projectId integer No read-only (server-generated) Project that this incident belongs to

Response example

[
  {
    "creationTime": "2021-03-01T18:10:09Z",
    "description": "RECOVERY: humidity sensor connection is back to normal",
    "evaluationTimeRange": {
      "begin": "2021-03-01T18:08:09Z",
      "end": "2021-03-01T18:09:09Z"
    },
    "homeId": 100,
    "incidentType": "recovery",
    "moduleId": "tsdb",
    "monitorId": 1347,
    "monitorSnapshot": {
      "condition": {
        "conditionType": "timeSeriesHeartbeat",
        "interval": 60,
        "seriesId": "humidity"
      },
      "description": "",
      "evaluationDelay": 60,
      "incidentCustomDescriptions": {
        "alert": "ALERT: check if the humidity sensor is connected",
        "recovery": "RECOVERY: humidity sensor connection is back to normal"
      },
      "name": "humidity sensor heartbeat"
    },
    "projectId": 1234
  },
  {
    "creationTime": "2021-03-01T17:02:08Z",
    "description": "ALERT: check if the humidity sensor is connected",
    "evaluationTimeRange": {
      "begin": "2021-03-01T17:00:08Z",
      "end": "2021-03-01T17:01:08Z"
    },
    "homeId": 100,
    "incidentType": "alert",
    "moduleId": "tsdb",
    "monitorId": 1347,
    "monitorSnapshot": {
      "condition": {
        "conditionType": "timeSeriesHeartbeat",
        "interval": 60,
        "seriesId": "humidity"
      },
      "description": "",
      "evaluationDelay": 60,
      "incidentCustomDescriptions": {
        "alert": "ALERT: check if the humidity sensor is connected",
        "recovery": "RECOVERY: humidity sensor connection is back to normal"
      },
      "name": "humidity sensor heartbeat"
    },
    "projectId": 1234
  }
]

`401` Authorization is required to access this resource.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`403` Request failed because of denied permission.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`429` Request failed because of rate limit.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`500` An unexpected error has occurred.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`503` The service is temporarily unavailable.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

Get all incidents in a home

Authentication

Path parameters

Query parameters

Responses

200 An array of monitors are returned.

Response example

401 Authorization is required to access this resource.

403 Request failed because of denied permission.

429 Request failed because of rate limit.

500 An unexpected error has occurred.

503 The service is temporarily unavailable.

`200` An array of monitors are returned.

`401` Authorization is required to access this resource.

`403` Request failed because of denied permission.

`429` Request failed because of rate limit.

`500` An unexpected error has occurred.

`503` The service is temporarily unavailable.