Page Comparison

...

Parameters:

tenant – User tenant.
project_id – Project identifier.

JSON Data:

Data is passed in as a JSON object.

Valid object keys:

name (required) – Human-readable name of the trend detection entity.
query (required) – The query on which the trend is analyzed. The query may be an empty string, in which case all items in the project are analyzed.
email_user (required) – Email address to send an alert to when an anomaly is detected.
aggregation_interval (required) –
aggregation_field – Facet field on which to detect the trends. If this is not specified, the trend is computed on the number of results in a time frame.
aggregation_method – Aggregation method on how the numeric values are combined. Only used if aggregation_field is set too.
Valid options: avg (default), sum, max, min
aggregation_time_field – Datetime facet field on which axis to calculate the trend. This defaults to $item_created_at.
noise –

Headers: See Common Headers.

Status Codes:

201 – Trend detection entity created.

See also Common Status Codes.

Returns:

Created trend detection in the "data" property.

Code Block

	js
	js

{
    "deprecated": false, 
    "data": {
        "aggregation_time_field": "$item_created_at", 
        "aggregation_field": "Price", 
        "name": "EU Egg Price Trend", 
        "created_at": "2016-06-15T11:15:46", 
        "modified_at": "2016-06-15T11:15:46", 
        "aggregation_interval": "1d", 
        "aggregation_method": "avg", 
        "query": "Type:\"Egg Price\" \"Country\":EU", 
        "project_id": "V73xio3rR6-8lPwBOG_EVA", 
        "id": "hI9E58PvT_mTPtpC6_rQkQ"
    }, 
    "id": "2e4fe4f6-2b7e-4815-946e-2b904cd3c66d", 
    "apiVersion": "v0"
}

...

Parameters:

tenant – User tenant.
project_id – Project identifier.
tde_id – Trend Detection Entity identifier.

Query Parameters:

Parameters are optional.

thresholds_before – Date and Time string. Return thresholds from before this timestamp.
thresholds_after – Date and Time string. Return thresholds from after this timestamp.

Headers:

See Common Headers.

Status Codes:

200 – Thresholds returned.

See also Common Status Codes.

Returns:

Thresholds in the "data" property.

Code Block

language	js

{
    "deprecated": false, 
    "data": {
        "thresholds": [
            {
                "count": 127.8694520548, 
                "timestamp": "2015-01-05T00:00:00"
            }, 
            {
                "count": 126.9704256148, 
                "timestamp": "2015-01-12T00:00:00"
            }, 
            {
                "count": 126.2358246885, 
                "timestamp": "2015-01-19T00:00:00"
            }, 
            {
                "count": 125.6758949924, 
                "timestamp": "2015-01-26T00:00:00"
            }
        ]
    }, 
    "id": "d7d8ec43-1aba-441b-b6fd-73709b97debd", 
    "apiVersion": "v0"
}

...

Returns the detected labels (anomalies) in the data.

Parameters:

tenant – User tenant.
project_id – Project identifier.
tde_id – Trend Detection Entity identifier.

Query Parameters:

Parameters are optional.

labels_before – Date and Time string. Return labels from before this timestamp.
labels_after – Date and Time string. Return labels from after this timestamp.

Headers:

See Common Headers.

Status Codes:

200 – Labels returned.

See also Common Status Codes.

Returns:

Labels in the "data" property.

Code Block

language	js

{
    "deprecated": false, 
    "data": {
        "labels": [
            "2015-04-06T00:00:00"
        ]
    }, 
    "id": "119f1156-9267-40e4-9aa5-edcf0f56a0bb", 
    "apiVersion": "v0"
}

This output signifies that the data contains one anomaly in the data, namely in the aggregation interval that starts on 2015-04-06 midnight.

Get Predictions

GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/trenddetections/{id: tde_id}/predictions

Returns the future predicted thresholds for the given Trend Detection Entity. This returns predictions for the same time range on which data has been processed already.

Parameters:

tenant – User tenant.
project_id – Project identifier.
tde_id – Trend Detection Entity identifier.

Headers:

See Common Headers.

Status Codes:

200 – Thresholds returned.

See also Common Status Codes.

Returns:

Predictions in the "data" property.

The example output below has been cut.

Code Block

language	js

{
    "deprecated": false, 
    "data": {
        "predictions": [
            {
                "timestamp": "2016-02-22T00:00:00", 
                "prediction_value": 8.3393183124, 
                "prediction_threshold": 11.1056841591
            }, 
            {
                "timestamp": "2016-02-29T00:00:00", 
                "prediction_value": 11.9445990546, 
                "prediction_threshold": 12.7986151892
            }
        ]
    }, 
    "id": "f62822b9-1f54-4c54-bcf7-c87f016b3715", 
    "apiVersion": "v0"
}

This output shows two time buckets (weekly interval) with a predicted value and the anomaly threshold for each of those buckets.

Versions Compared

Old Version 1

New Version 2

Key

Get Predictions