Timeseries Alarm List – Django REST framework

A Timeseries Alarm adds minimum or maximum thresholds to a Timeseries.

Alarms are triggered on import of new timeseries data. Direct messages E-mails and/or sms-es are sent when a threshold is exceeded. If the message contains the [[var:warning_value]], [[var:warning_timestamp]] or [[var:warning_level]] placeholder tags these will be replaced by the most extreme threshold value and status.

Custom route: triggers Generate a response containing: "history", "url", “timestamp”, “value”, “threshold_level”, “threshold_name”, “message_sent”.

Query parameters

uuid: Text filter on uuid. Supports a comma-separated list of (fragments of) UUIDs. UUIDs must be specified in their canonical form (with hyphens, that is). Case insensitive. Only supports uuid__icontains, the default.

name: Text filter on name. Supports various lookup types (name__exact by default).

active: Boolean filter on active. Either true or false.

warning_threshold: Text filter on warning_threshold. Supports various lookup types (name__exact by default).

warning_timestamp: Text filter on warning_timestamp. Supports various lookup types (name__exact by default).

warning_value: Text filter on warning_value. Supports various lookup types (name__exact by default).

timeseries: Related filter on timeseries__id and timeseries__uuid. See the timeseries endpoint.

thresholds: Related filter on thresholds. See the thresholds endpoint.

messages: Related filter on messages. See the messages endpoint.

organisation: Related filter on organisation. See the organisations endpoint.

page_size: The maximum number of results to return in list-view. The default is 10.

ordering Show the results in a specific order. You can order them by id, name, organisation__name, timeseries. Add a - in front to reverse the order.

created: Temporal filter on created. Supports various lookup types (exact, lt, lte, gt, gte; created__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

last_modified: Temporal filter on last_modified. Supports various lookup types (exact, lt, lte, gt, gte; last_modified__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

Examples

?name=Example

?name__icontains=Examp

?name__icontains=Examp&page_size=100

?organisation__uuid=c5e37ca3495045168f5d911c37ee2319

?active=true

?ordering=-organisation__name

?created__gte=2017-01-01T00:00:00Z

?last_modified__lt=2018-01-01T00:00:00Z

GET /api/v4/timeseriesalarms/?format=api

HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 0,
    "next": null,
    "previous": null,
    "results": []
}