Excerpt |
---|
Trend Detections are Detection is configured on projects to look for anomalies in time series data. |
For an introduction and tutorial on this feature, read the
Trend Detection chapter.
Methods
Table of Contents |
---|
outline | true |
---|
exclude | Methods |
---|
|
List Trend Detection Entities
GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/trenddetections
...
Parameters: | - tenant – User tenant.
- project_id – Project identifier.
|
---|
Headers: | See Common Headers. |
---|
Status Codes: | - 200 – All trend detection entities are returned.
See also Common Status Codes. |
---|
Returns: | List of configured trend detection entities in the "data" property. Code Block |
---|
| {
"deprecated": false,
"data": {
"trend_detection_entities": [
{
"aggregation_time_field": "$item_created_at",
"aggregation_field": "Price",
"name": "EU Egg Price Trend",
"created_at": "2016-06-07T10:52:05",
"modified_at": "2016-06-07T10:52:07",
"aggregation_interval": "1w",
"aggregation_method": "avg",
"query": "Type:\"Egg Price\" \"Country\":EU",
"project_id": "j0mN4DgQTGWDSBP3QcqDwg",
"id": "em_I-hJMRzi-OjvObOqU6A"
}
]
},
"id": "0a878cc1-e100-4b41-93e6-40e9ed184883",
"apiVersion": "v0"
} |
|
---|
Create Trend Detection Entity
POST https://squirro-endpoint/api/topic
/v0/(string: tenant)/projects/(id: project_id)/trenddetections
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) – Determines the time buckets into which the data is fitted.
The format of the interval is "<number><unit>" - for example "1d" for a daily interval. The full list of allowed units is "m" - minute, "h" - hour , "d" - day, "w" - week. See the Aggregation Interval reference for full details on this parameter. - 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. See the Aggregation Method reference for full details on this parameter. - aggregation_time_field – Datetime facet field on which axis to calculate the trend. This defaults to
$item_created_at .
|
---|
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 |
---|
| {
"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"
} |
|
---|
Get Trend Detection Entity
GET https://squirro-endpoint/api/topic
/
v0/(string: tenant)/projects/(id: project_id)/trenddetections/(id: tde_id)
Parameters: | - tenant – User tenant.
- project_id – Project identifier.
- tde_id – Trend Detection Entity identifier.
|
---|
Headers: | See Common Headers. |
---|
Status Codes: | - 200 – Trend Detection Entity returned.
See also Common Status Codes. |
---|
Returns: | Trend Detection Entity in the "data" property. Code Block |
---|
| {
"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": "49d2bc0a-163a-48e1-9fa6-238770e8e488",
"apiVersion": "v0"
} |
|
---|
Delete Trend Detection Entity
DELETE https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/trenddetections
/(id: tde_id)
Parameters: | - tenant – User tenant.
- project_id – Project identifier.
- tde_id – Trend Detection Entity identifier.
|
---|
Headers: | See Common Headers. |
---|
Status Codes: | - 204 – Trend Detection Entity deleted.
See also Common Status Codes. |
---|
Get Thresholds
GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/trenddetections/{id: tde_id}/thresholds
...
Parameters: | - tenant – User tenant.
- project_id – Project identifier.
- tde_id – Trend Detection Entity identifier.
|
---|
Query Parameters: | Parameters are optional. |
---|
Headers: | See Common Headers. |
---|
Status Codes: | - 200 – Thresholds returned.
See also Common Status Codes. |
---|
Returns: | Thresholds in the "data" property. Code Block |
---|
| {
"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"
} |
|
---|
Get Labels
GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/trenddetections/{id: tde_id}/labels
...
Parameters: | - tenant – User tenant.
- project_id – Project identifier.
- tde_id – Trend Detection Entity identifier.
|
---|
Query Parameters: | Parameters are optional. |
---|
Headers: | See Common Headers. |
---|
Status Codes: | See also Common Status Codes. |
---|
Returns: | Labels in the "data" property. Code Block |
---|
| {
"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
...