Project "Gualala"
Create anomaly alerting configuration
anomaly alerting configuration
{
"name": "alerting configuration name",
"crossMetricsOperator": "AND",
"hookIds": [
"00000000-0000-0000-0000-000000000001"
],
"metricAlertingConfigurations": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"anomalyScopeType": "All",
"negationOperation": false,
"severityFilter": {
"minAlertSeverity": "Medium",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
}
},
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
"anomalyScopeType": "Dimension",
"negationOperation": false,
"dimensionAnomalyScope": {
"dimension": {
"city": "Beijing"
}
},
"severityFilter": {
"minAlertSeverity": "Low",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
},
"valueFilter": {
"lower": 0,
"upper": 1000,
"direction": "Both",
"triggerForMissing": false
}
}
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create anomaly detection configuration
anomaly detection configuration
{
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create a new data feed
parameters to create a data feed
{
"dataSourceParameter": {
"connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;",
"query": "select * from your_table where timestamp = @StartTime"
},
"dataFeedName": "Sample - cost/revenue - city/category",
"dataFeedDescription": "This is a sample data feed.",
"granularityName": "Daily",
"metrics": [
{
"metricName": "cost",
"metricDisplayName": "cost"
},
{
"metricName": "revenue",
"metricDisplayName": "revenue"
}
],
"dimension": [
{
"dimensionName": "category",
"dimensionDisplayName": "category"
},
{
"dimensionName": "city",
"dimensionDisplayName": "city"
}
],
"timestampColumn": "timestamp",
"dataStartFrom": "2020-01-01T00:00:00.0000000+00:00",
"dataSourceType": "SqlServer",
"startOffsetInSeconds": 86400,
"maxConcurrency": 5,
"minRetryIntervalInSeconds": 3600,
"stopRetryAfterInSeconds": 604800,
"needRollup": "NeedRollup",
"rollUpMethod": "Sum",
"allUpIdentification": "__SUM__",
"fillMissingPointType": "SmartFilling",
"viewMode": "Private",
"isAdmin": false
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create a new hook
Create hook request
{
"hookParameter": {
"endpoint": "https://localhost/demo/post"
},
"hookName": "A webhook",
"hookType": "Webhook",
"description": "This is a webhook.",
"externalLink": ""
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create a new metric feedback
metric feedback
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-01-01T00:00:00.0000000+00:00",
"value": {
"anomalyValue": "NotAnomaly"
},
"sourceInfo": {
"anomalyDetectionConfiguration": {
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
},
"metricId": "22222222-2222-2222-2222-000000000001",
"dimensionFilter": {
"dimension": {
"city": "Beijing"
}
},
"feedbackType": "Anomaly"
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Delete anomaly alerting configuration
Format - uuid. anomaly alerting configuration unique id
The resource is deleted successfully or does not exist.
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Delete anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
The resource is deleted successfully or does not exist.
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Delete a data feed
Format - uuid. The data feed unique id
The resource is deleted successfully or does not exist.
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Delete a hook
Format - uuid. Hook unique ID
The resource is deleted successfully or does not exist.
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query alerts under anomaly alerting configuration
Format - uuid. anomaly alerting configuration unique id
query alerting result request
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"timeMode": "AnomalyTime"
}
Success
{
"value": [
{
"alertId": "aaaaaaaaaaaa",
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"createdTime": "2020-07-21T17:26:50.0000000+00:00",
"modifiedTime": "2020-07-21T17:26:50.0000000+00:00"
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query anomalies under anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
query detection anomaly result request
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"filter": {
"dimensionFilter": [
{
"dimension": {
"city": "Beijing"
}
}
],
"severityFilter": {
"min": "Low",
"max": "High"
}
}
}
Success
{
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"createdTime": "2020-07-21T17:26:50.0000000+00:00",
"modifiedTime": "2020-07-21T17:26:50.0000000+00:00",
"dimension": {
"category": "__SUM__",
"city": "Beijing"
},
"property": {
"anomalySeverity": "High",
"anomalyStatus": "Active"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query anomalies under a specific alert
Format - uuid. anomaly alerting configuration unique id
alert id
Format - int32.
Format - int32.
Success
{
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"createdTime": "2020-07-21T17:26:50.0000000+00:00",
"modifiedTime": "2020-07-21T17:26:50.0000000+00:00",
"dimension": {
"category": "__SUM__",
"city": "Beijing"
},
"property": {
"anomalySeverity": "High",
"anomalyStatus": "Active"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query a single anomaly alerting configuration
Format - uuid. anomaly alerting configuration unique id
Success
{
"anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001",
"name": "alerting configuration name",
"crossMetricsOperator": "AND",
"hookIds": [
"00000000-0000-0000-0000-000000000001"
],
"metricAlertingConfigurations": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"anomalyScopeType": "All",
"negationOperation": false,
"severityFilter": {
"minAlertSeverity": "Medium",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
}
},
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
"anomalyScopeType": "Dimension",
"negationOperation": false,
"dimensionAnomalyScope": {
"dimension": {
"city": "Beijing"
}
},
"severityFilter": {
"minAlertSeverity": "Low",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
},
"valueFilter": {
"lower": 0,
"upper": 1000,
"direction": "Both",
"triggerForMissing": false
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query all anomaly alerting configurations for specific anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
Success
{
"value": [
{
"anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001",
"name": "alerting configuration name",
"crossMetricsOperator": "AND",
"hookIds": [
"00000000-0000-0000-0000-000000000001"
],
"metricAlertingConfigurations": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"anomalyScopeType": "All",
"negationOperation": false,
"severityFilter": {
"minAlertSeverity": "Medium",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
}
},
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
"anomalyScopeType": "Dimension",
"negationOperation": false,
"dimensionAnomalyScope": {
"dimension": {
"city": "Beijing"
}
},
"severityFilter": {
"minAlertSeverity": "Low",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
},
"valueFilter": {
"lower": 0,
"upper": 1000,
"direction": "Both",
"triggerForMissing": false
}
}
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query a single anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
Success
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query all anomaly detection configurations for specific metric
Format - uuid. metric unique id
Success
{
"value": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get a data feed by its id
Format - uuid. The data feed unique id
Success
{
"dataSourceParameter": {
"connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;",
"query": "select * from your_table where timestamp = @StartTime"
},
"dataFeedId": "11111111-1111-1111-1111-000000000001",
"dataFeedName": "Sample - cost/revenue - city/category",
"dataFeedDescription": "This is a sample data feed.",
"granularityName": "Daily",
"metrics": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"metricName": "cost",
"metricDisplayName": "cost"
},
{
"metricId": "22222222-2222-2222-2222-000000000002",
"metricName": "revenue",
"metricDisplayName": "revenue"
}
],
"dimension": [
{
"dimensionName": "category",
"dimensionDisplayName": "category"
},
{
"dimensionName": "city",
"dimensionDisplayName": "city"
}
],
"timestampColumn": "timestamp",
"dataStartFrom": "2020-01-01T00:00:00.0000000+00:00",
"dataSourceType": "SqlServer",
"startOffsetInSeconds": 86400,
"maxConcurrency": 5,
"minRetryIntervalInSeconds": 3600,
"stopRetryAfterInSeconds": 604800,
"needRollup": "NeedRollup",
"rollUpMethod": "Sum",
"allUpIdentification": "__SUM__",
"fillMissingPointType": "SmartFilling",
"viewMode": "Private",
"admins": [
"admin@company.example"
],
"viewers": [ ],
"isAdmin": true,
"creator": "admin@company.example",
"status": "Active",
"createdTime": "2020-03-01T00:00:00.0000000+00:00"
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get data ingestion status by data feed
Format - uuid. The data feed unique id
The query time range
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00"
}
Success
{
"@nextLink": "https://localhost/dataFeeds/01234567-8901-2345-6789-012345678901/ingestionStatus/query?$skip=2&$top=2",
"value": [
{
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"status": "Succeeded",
"message": ""
},
{
"timestamp": "2020-01-02T00:00:00.0000000+00:00",
"status": "Succeeded",
"message": ""
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query dimension values of anomalies
Format - uuid. anomaly detection configuration unique id
query dimension values request
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"dimensionName": "category",
"dimensionFilter": {
"dimension": {
"city": "Beijing"
}
}
}
Success
{
"value": [
"Jewelry"
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query anomaly detection status
Format - uuid. metric unique id
query options
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00"
}
Success
{
"@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/status/enrichment/anomalyDetection/query?$skip=2&$top=2",
"value": [
{
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"status": "Succeeded",
"message": ""
},
{
"timestamp": "2020-01-02T00:00:00.0000000+00:00",
"status": "Succeeded",
"message": ""
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get a hook by its id
Format - uuid. Hook unique ID
Success
{
"hookParameter": {
"endpoint": "https://localhost/demo/post"
},
"hookId": "00000000-0000-0000-0000-000000000001",
"hookName": "A webhook",
"hookType": "Webhook",
"description": "This is a webhook.",
"externalLink": "",
"admins": [
"admin@company.example"
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query incidents under anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
query detection incident result request
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"filter": {
"dimensionFilter": [
{
"dimension": {
"city": "Beijing"
}
}
]
}
}
Success
{
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"incidentId": "iiiiiiiiiiii",
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"lastTime": "2020-02-01T00:00:00.0000000+00:00",
"rootNode": {
"dimension": {
"category": "__SUM__",
"city": "Beijing"
}
},
"property": {
"maxSeverity": "High",
"incidentStatus": "Active"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query incidents under a specific alert
Format - uuid. anomaly alerting configuration unique id
alert id
Format - int32.
Format - int32.
Success
{
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"incidentId": "iiiiiiiiiiii",
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"lastTime": "2020-02-01T00:00:00.0000000+00:00",
"rootNode": {
"dimension": {
"category": "__SUM__",
"city": "Beijing"
}
},
"property": {
"maxSeverity": "High",
"incidentStatus": "Active"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get data last success ingestion job timestamp by data feed
Format - uuid. The data feed unique id
Success
{
"latestSuccessTimestamp": "2020-01-30T00:00:00.0000000+00:00",
"latestActiveTimestamp": "2020-01-31T00:00:00.0000000+00:00"
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get time series data from metric
Format - uuid. metric unique id
query time series data condition
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"series": [
{
"category": "__SUM__",
"city": "Beijing"
}
]
}
Success
{
"@nextLink": "https://localhost/metrics/11112222-3333-4444-5555-666677778888/series/data/query?$skip=1&$top=1",
"value": [
{
"id": {
"metricId": "22222222-2222-2222-2222-000000000001",
"dimension": {
"category": "__SUM__",
"city": "Beijing"
}
},
"timestampList": [
"2020-01-01T00:00:00.0000000+00:00",
"2020-01-02T00:00:00.0000000+00:00"
],
"valueList": [
2.71828182845905,
3.14159265358979
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List dimension from certain metric
Format - uuid. metric unique id
query dimension option
Format - int32.
Format - int32.
{
"dimensionName": "city"
}
Success
{
"@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/dimension/query?$skip=2&$top=2",
"value": [
"__SUM__",
"Beijing"
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get a metric feedback by its id
Format - uuid.
Success
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-01-01T00:00:00.0000000+00:00",
"value": {
"anomalyValue": "NotAnomaly"
},
"sourceInfo": {
"anomalyDetectionConfiguration": {
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
},
"feedbackId": "99999999-9999-9999-9999-000000000001",
"createdTime": "2020-03-01T00:00:00.0000000+00:00",
"userPrincipal": "viewer@company.example",
"metricId": "22222222-2222-2222-2222-000000000001",
"dimensionFilter": {
"dimension": {
"city": "Beijing"
}
},
"feedbackType": "Anomaly"
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List series (dimension combinations) from metric
Format - uuid. metric unique id
filter to query series
Format - int32.
Format - int32.
{
"activeSince": "2020-01-01T00:00:00.0000000+00:00",
"dimensionFilter": {
"city": [
"Beijing"
]
}
}
Success
{
"@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/series/dimension/query?$skip=2&$top=2",
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"dimension": {
"category": "__SUM__",
"city": "Beijing"
}
},
{
"metricId": "22222222-2222-2222-2222-000000000001",
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query root cause for incident
Format - uuid. anomaly detection configuration unique id
incident id
Success
{
"value": [
{
"rootCause": {
"dimension": {
"city": "Beijing"
}
},
"path": [
"city"
],
"score": 0.67,
"description": "city = Beijing contributes the most to this anomaly."
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query series enriched by anomaly detection
Format - uuid. anomaly detection configuration unique id
query series detection result request
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"series": [
{
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
}
]
}
Success
{
"value": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"timestampList": [
"2020-01-01T00:00:00.0000000+00:00"
],
"valueList": [
108.3
],
"isAnomalyList": [
false
],
"periodList": [
0
],
"expectedValueList": [
108
],
"lowerBoundaryList": [
100.1
],
"upperBoundaryList": [
112.8
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List all data feeds
filter data feed by its name
filter data feed by its source type
filter data feed by its granularity
filter data feed by its status
filter data feed by its creator
Format - int32.
Format - int32.
Success
{
"@nextLink": "https://localhost/dataFeeds?$skip=1&$top=1",
"value": [
{
"dataSourceParameter": {
"connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;",
"query": "select * from your_table where timestamp = @StartTime"
},
"dataFeedId": "11111111-1111-1111-1111-000000000001",
"dataFeedName": "Sample - cost/revenue - city/category",
"dataFeedDescription": "This is a sample data feed.",
"granularityName": "Daily",
"metrics": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"metricName": "cost",
"metricDisplayName": "cost"
},
{
"metricId": "22222222-2222-2222-2222-000000000002",
"metricName": "revenue",
"metricDisplayName": "revenue"
}
],
"dimension": [
{
"dimensionName": "category",
"dimensionDisplayName": "category"
},
{
"dimensionName": "city",
"dimensionDisplayName": "city"
}
],
"timestampColumn": "timestamp",
"dataStartFrom": "2020-01-01T00:00:00.0000000+00:00",
"dataSourceType": "SqlServer",
"startOffsetInSeconds": 86400,
"maxConcurrency": 5,
"minRetryIntervalInSeconds": 3600,
"stopRetryAfterInSeconds": 604800,
"needRollup": "NeedRollup",
"rollUpMethod": "Sum",
"allUpIdentification": "__SUM__",
"fillMissingPointType": "SmartFilling",
"viewMode": "Private",
"admins": [
"admin@company.example"
],
"viewers": [ ],
"isAdmin": true,
"creator": "admin@company.example",
"status": "Active",
"createdTime": "2020-03-01T00:00:00.0000000+00:00"
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List all hooks
filter hook by its name
Format - int32.
Format - int32.
Success
{
"@nextLink": "https://localhost/hooks?$skip=1&$top=1",
"value": [
{
"hookParameter": {
"endpoint": "https://localhost/demo/post"
},
"hookId": "00000000-0000-0000-0000-000000000001",
"hookName": "A webhook",
"hookType": "Webhook",
"description": "This is a webhook.",
"externalLink": "",
"admins": [
"admin@company.example"
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List feedback on the given metric
metric feedback filter
Format - int32.
Format - int32.
{
"valueFilter": {
"anomalyValue": "NotAnomaly"
},
"metricId": "22222222-2222-2222-2222-000000000001",
"feedbackType": "Anomaly",
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-01-01T00:00:00.0000000+00:00",
"userPrincipal": "viewer@company.example"
}
Success
{
"@nextLink": "https://localhost/feedback?$skip=1&$top=1",
"value": [
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-01-01T00:00:00.0000000+00:00",
"value": {
"anomalyValue": "NotAnomaly"
},
"sourceInfo": {
"anomalyDetectionConfiguration": {
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
},
"feedbackId": "99999999-9999-9999-9999-000000000001",
"createdTime": "2020-03-01T00:00:00.0000000+00:00",
"userPrincipal": "viewer@company.example",
"metricId": "22222222-2222-2222-2222-000000000001",
"dimensionFilter": {
"dimension": {
"city": "Beijing"
}
},
"feedbackType": "Anomaly"
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Reset data ingestion status by data feed to backfill data
Format - uuid. The data feed unique id
The backfill time range
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00"
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Update anomaly alerting configuration
Format - uuid. anomaly alerting configuration unique id
anomaly alerting configuration
{
"name": "alerting configuration name",
"crossMetricsOperator": "AND",
"hookIds": [
"00000000-0000-0000-0000-000000000001"
],
"metricAlertingConfigurations": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"anomalyScopeType": "All",
"negationOperation": false,
"severityFilter": {
"minAlertSeverity": "Medium",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
}
},
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
"anomalyScopeType": "Dimension",
"negationOperation": false,
"dimensionAnomalyScope": {
"dimension": {
"city": "Beijing"
}
},
"severityFilter": {
"minAlertSeverity": "Low",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
},
"valueFilter": {
"lower": 0,
"upper": 1000,
"direction": "Both",
"triggerForMissing": false
}
}
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Update anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
anomaly detection configuration
{
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Update a data feed
Format - uuid. The data feed unique id
parameters to update a data feed
{
"dataFeedName": "Sample - cost/revenue - city/category (modified)",
"viewers": [
"viewer@company.example"
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Update a hook
Format - uuid. Hook unique ID
Update hook request
{
"hookName": "A webhook (modified)",
"description": "This is a webhook. (modified)"
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create anomaly alerting configuration
anomaly alerting configuration
{
"name": "alerting configuration name",
"crossMetricsOperator": "AND",
"hookIds": [
"00000000-0000-0000-0000-000000000001"
],
"metricAlertingConfigurations": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"anomalyScopeType": "All",
"negationOperation": false,
"severityFilter": {
"minAlertSeverity": "Medium",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
}
},
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
"anomalyScopeType": "Dimension",
"negationOperation": false,
"dimensionAnomalyScope": {
"dimension": {
"city": "Beijing"
}
},
"severityFilter": {
"minAlertSeverity": "Low",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
},
"valueFilter": {
"lower": 0,
"upper": 1000,
"direction": "Both",
"triggerForMissing": false
}
}
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create anomaly detection configuration
anomaly detection configuration
{
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create a new data feed
parameters to create a data feed
{
"dataSourceParameter": {
"connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;",
"query": "select * from your_table where timestamp = @StartTime"
},
"dataFeedName": "Sample - cost/revenue - city/category",
"dataFeedDescription": "This is a sample data feed.",
"granularityName": "Daily",
"metrics": [
{
"metricName": "cost",
"metricDisplayName": "cost"
},
{
"metricName": "revenue",
"metricDisplayName": "revenue"
}
],
"dimension": [
{
"dimensionName": "category",
"dimensionDisplayName": "category"
},
{
"dimensionName": "city",
"dimensionDisplayName": "city"
}
],
"timestampColumn": "timestamp",
"dataStartFrom": "2020-01-01T00:00:00.0000000+00:00",
"dataSourceType": "SqlServer",
"startOffsetInSeconds": 86400,
"maxConcurrency": 5,
"minRetryIntervalInSeconds": 3600,
"stopRetryAfterInSeconds": 604800,
"needRollup": "NeedRollup",
"rollUpMethod": "Sum",
"allUpIdentification": "__SUM__",
"fillMissingPointType": "SmartFilling",
"viewMode": "Private",
"isAdmin": false
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create a new hook
Create hook request
{
"hookParameter": {
"endpoint": "https://localhost/demo/post"
},
"hookName": "A webhook",
"hookType": "Webhook",
"description": "This is a webhook.",
"externalLink": ""
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create a new metric feedback
metric feedback
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-01-01T00:00:00.0000000+00:00",
"value": {
"anomalyValue": "NotAnomaly"
},
"sourceInfo": {
"anomalyDetectionConfiguration": {
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
},
"metricId": "22222222-2222-2222-2222-000000000001",
"dimensionFilter": {
"dimension": {
"city": "Beijing"
}
},
"feedbackType": "Anomaly"
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Delete anomaly alerting configuration
Format - uuid. anomaly alerting configuration unique id
The resource is deleted successfully or does not exist.
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Delete anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
The resource is deleted successfully or does not exist.
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Delete a data feed
Format - uuid. The data feed unique id
The resource is deleted successfully or does not exist.
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Delete a hook
Format - uuid. Hook unique ID
The resource is deleted successfully or does not exist.
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query alerts under anomaly alerting configuration
Format - uuid. anomaly alerting configuration unique id
query alerting result request
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"timeMode": "AnomalyTime"
}
Success
{
"value": [
{
"alertId": "aaaaaaaaaaaa",
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"createdTime": "2020-07-21T17:26:50.0000000+00:00",
"modifiedTime": "2020-07-21T17:26:50.0000000+00:00"
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query anomalies under anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
query detection anomaly result request
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"filter": {
"dimensionFilter": [
{
"dimension": {
"city": "Beijing"
}
}
],
"severityFilter": {
"min": "Low",
"max": "High"
}
}
}
Success
{
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"createdTime": "2020-07-21T17:26:50.0000000+00:00",
"modifiedTime": "2020-07-21T17:26:50.0000000+00:00",
"dimension": {
"category": "__SUM__",
"city": "Beijing"
},
"property": {
"anomalySeverity": "High",
"anomalyStatus": "Active"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query anomalies under a specific alert
Format - uuid. anomaly alerting configuration unique id
alert id
Format - int32.
Format - int32.
Success
{
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"createdTime": "2020-07-21T17:26:50.0000000+00:00",
"modifiedTime": "2020-07-21T17:26:50.0000000+00:00",
"dimension": {
"category": "__SUM__",
"city": "Beijing"
},
"property": {
"anomalySeverity": "High",
"anomalyStatus": "Active"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query a single anomaly alerting configuration
Format - uuid. anomaly alerting configuration unique id
Success
{
"anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001",
"name": "alerting configuration name",
"crossMetricsOperator": "AND",
"hookIds": [
"00000000-0000-0000-0000-000000000001"
],
"metricAlertingConfigurations": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"anomalyScopeType": "All",
"negationOperation": false,
"severityFilter": {
"minAlertSeverity": "Medium",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
}
},
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
"anomalyScopeType": "Dimension",
"negationOperation": false,
"dimensionAnomalyScope": {
"dimension": {
"city": "Beijing"
}
},
"severityFilter": {
"minAlertSeverity": "Low",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
},
"valueFilter": {
"lower": 0,
"upper": 1000,
"direction": "Both",
"triggerForMissing": false
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query all anomaly alerting configurations for specific anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
Success
{
"value": [
{
"anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001",
"name": "alerting configuration name",
"crossMetricsOperator": "AND",
"hookIds": [
"00000000-0000-0000-0000-000000000001"
],
"metricAlertingConfigurations": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"anomalyScopeType": "All",
"negationOperation": false,
"severityFilter": {
"minAlertSeverity": "Medium",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
}
},
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
"anomalyScopeType": "Dimension",
"negationOperation": false,
"dimensionAnomalyScope": {
"dimension": {
"city": "Beijing"
}
},
"severityFilter": {
"minAlertSeverity": "Low",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
},
"valueFilter": {
"lower": 0,
"upper": 1000,
"direction": "Both",
"triggerForMissing": false
}
}
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query a single anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
Success
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query all anomaly detection configurations for specific metric
Format - uuid. metric unique id
Success
{
"value": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get a data feed by its id
Format - uuid. The data feed unique id
Success
{
"dataSourceParameter": {
"connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;",
"query": "select * from your_table where timestamp = @StartTime"
},
"dataFeedId": "11111111-1111-1111-1111-000000000001",
"dataFeedName": "Sample - cost/revenue - city/category",
"dataFeedDescription": "This is a sample data feed.",
"granularityName": "Daily",
"metrics": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"metricName": "cost",
"metricDisplayName": "cost"
},
{
"metricId": "22222222-2222-2222-2222-000000000002",
"metricName": "revenue",
"metricDisplayName": "revenue"
}
],
"dimension": [
{
"dimensionName": "category",
"dimensionDisplayName": "category"
},
{
"dimensionName": "city",
"dimensionDisplayName": "city"
}
],
"timestampColumn": "timestamp",
"dataStartFrom": "2020-01-01T00:00:00.0000000+00:00",
"dataSourceType": "SqlServer",
"startOffsetInSeconds": 86400,
"maxConcurrency": 5,
"minRetryIntervalInSeconds": 3600,
"stopRetryAfterInSeconds": 604800,
"needRollup": "NeedRollup",
"rollUpMethod": "Sum",
"allUpIdentification": "__SUM__",
"fillMissingPointType": "SmartFilling",
"viewMode": "Private",
"admins": [
"admin@company.example"
],
"viewers": [ ],
"isAdmin": true,
"creator": "admin@company.example",
"status": "Active",
"createdTime": "2020-03-01T00:00:00.0000000+00:00"
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get data ingestion status by data feed
Format - uuid. The data feed unique id
The query time range
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00"
}
Success
{
"@nextLink": "https://localhost/dataFeeds/01234567-8901-2345-6789-012345678901/ingestionStatus/query?$skip=2&$top=2",
"value": [
{
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"status": "Succeeded",
"message": ""
},
{
"timestamp": "2020-01-02T00:00:00.0000000+00:00",
"status": "Succeeded",
"message": ""
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query dimension values of anomalies
Format - uuid. anomaly detection configuration unique id
query dimension values request
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"dimensionName": "category",
"dimensionFilter": {
"dimension": {
"city": "Beijing"
}
}
}
Success
{
"value": [
"Jewelry"
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query anomaly detection status
Format - uuid. metric unique id
query options
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00"
}
Success
{
"@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/status/enrichment/anomalyDetection/query?$skip=2&$top=2",
"value": [
{
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"status": "Succeeded",
"message": ""
},
{
"timestamp": "2020-01-02T00:00:00.0000000+00:00",
"status": "Succeeded",
"message": ""
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get a hook by its id
Format - uuid. Hook unique ID
Success
{
"hookParameter": {
"endpoint": "https://localhost/demo/post"
},
"hookId": "00000000-0000-0000-0000-000000000001",
"hookName": "A webhook",
"hookType": "Webhook",
"description": "This is a webhook.",
"externalLink": "",
"admins": [
"admin@company.example"
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query incidents under anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
query detection incident result request
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"filter": {
"dimensionFilter": [
{
"dimension": {
"city": "Beijing"
}
}
]
}
}
Success
{
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"incidentId": "iiiiiiiiiiii",
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"lastTime": "2020-02-01T00:00:00.0000000+00:00",
"rootNode": {
"dimension": {
"category": "__SUM__",
"city": "Beijing"
}
},
"property": {
"maxSeverity": "High",
"incidentStatus": "Active"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query incidents under a specific alert
Format - uuid. anomaly alerting configuration unique id
alert id
Format - int32.
Format - int32.
Success
{
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"incidentId": "iiiiiiiiiiii",
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"lastTime": "2020-02-01T00:00:00.0000000+00:00",
"rootNode": {
"dimension": {
"category": "__SUM__",
"city": "Beijing"
}
},
"property": {
"maxSeverity": "High",
"incidentStatus": "Active"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get data last success ingestion job timestamp by data feed
Format - uuid. The data feed unique id
Success
{
"latestSuccessTimestamp": "2020-01-30T00:00:00.0000000+00:00",
"latestActiveTimestamp": "2020-01-31T00:00:00.0000000+00:00"
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get time series data from metric
Format - uuid. metric unique id
query time series data condition
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"series": [
{
"category": "__SUM__",
"city": "Beijing"
}
]
}
Success
{
"@nextLink": "https://localhost/metrics/11112222-3333-4444-5555-666677778888/series/data/query?$skip=1&$top=1",
"value": [
{
"id": {
"metricId": "22222222-2222-2222-2222-000000000001",
"dimension": {
"category": "__SUM__",
"city": "Beijing"
}
},
"timestampList": [
"2020-01-01T00:00:00.0000000+00:00",
"2020-01-02T00:00:00.0000000+00:00"
],
"valueList": [
2.71828182845905,
3.14159265358979
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List dimension from certain metric
Format - uuid. metric unique id
query dimension option
Format - int32.
Format - int32.
{
"dimensionName": "city"
}
Success
{
"@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/dimension/query?$skip=2&$top=2",
"value": [
"__SUM__",
"Beijing"
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get a metric feedback by its id
Format - uuid.
Success
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-01-01T00:00:00.0000000+00:00",
"value": {
"anomalyValue": "NotAnomaly"
},
"sourceInfo": {
"anomalyDetectionConfiguration": {
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
},
"feedbackId": "99999999-9999-9999-9999-000000000001",
"createdTime": "2020-03-01T00:00:00.0000000+00:00",
"userPrincipal": "viewer@company.example",
"metricId": "22222222-2222-2222-2222-000000000001",
"dimensionFilter": {
"dimension": {
"city": "Beijing"
}
},
"feedbackType": "Anomaly"
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List series (dimension combinations) from metric
Format - uuid. metric unique id
filter to query series
Format - int32.
Format - int32.
{
"activeSince": "2020-01-01T00:00:00.0000000+00:00",
"dimensionFilter": {
"city": [
"Beijing"
]
}
}
Success
{
"@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/series/dimension/query?$skip=2&$top=2",
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"dimension": {
"category": "__SUM__",
"city": "Beijing"
}
},
{
"metricId": "22222222-2222-2222-2222-000000000001",
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query root cause for incident
Format - uuid. anomaly detection configuration unique id
incident id
Success
{
"value": [
{
"rootCause": {
"dimension": {
"city": "Beijing"
}
},
"path": [
"city"
],
"score": 0.67,
"description": "city = Beijing contributes the most to this anomaly."
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query series enriched by anomaly detection
Format - uuid. anomaly detection configuration unique id
query series detection result request
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"series": [
{
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
}
]
}
Success
{
"value": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"timestampList": [
"2020-01-01T00:00:00.0000000+00:00"
],
"valueList": [
108.3
],
"isAnomalyList": [
false
],
"periodList": [
0
],
"expectedValueList": [
108
],
"lowerBoundaryList": [
100.1
],
"upperBoundaryList": [
112.8
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List all data feeds
filter data feed by its name
filter data feed by its source type
filter data feed by its granularity
filter data feed by its status
filter data feed by its creator
Format - int32.
Format - int32.
Success
{
"@nextLink": "https://localhost/dataFeeds?$skip=1&$top=1",
"value": [
{
"dataSourceParameter": {
"connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;",
"query": "select * from your_table where timestamp = @StartTime"
},
"dataFeedId": "11111111-1111-1111-1111-000000000001",
"dataFeedName": "Sample - cost/revenue - city/category",
"dataFeedDescription": "This is a sample data feed.",
"granularityName": "Daily",
"metrics": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"metricName": "cost",
"metricDisplayName": "cost"
},
{
"metricId": "22222222-2222-2222-2222-000000000002",
"metricName": "revenue",
"metricDisplayName": "revenue"
}
],
"dimension": [
{
"dimensionName": "category",
"dimensionDisplayName": "category"
},
{
"dimensionName": "city",
"dimensionDisplayName": "city"
}
],
"timestampColumn": "timestamp",
"dataStartFrom": "2020-01-01T00:00:00.0000000+00:00",
"dataSourceType": "SqlServer",
"startOffsetInSeconds": 86400,
"maxConcurrency": 5,
"minRetryIntervalInSeconds": 3600,
"stopRetryAfterInSeconds": 604800,
"needRollup": "NeedRollup",
"rollUpMethod": "Sum",
"allUpIdentification": "__SUM__",
"fillMissingPointType": "SmartFilling",
"viewMode": "Private",
"admins": [
"admin@company.example"
],
"viewers": [ ],
"isAdmin": true,
"creator": "admin@company.example",
"status": "Active",
"createdTime": "2020-03-01T00:00:00.0000000+00:00"
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List all hooks
filter hook by its name
Format - int32.
Format - int32.
Success
{
"@nextLink": "https://localhost/hooks?$skip=1&$top=1",
"value": [
{
"hookParameter": {
"endpoint": "https://localhost/demo/post"
},
"hookId": "00000000-0000-0000-0000-000000000001",
"hookName": "A webhook",
"hookType": "Webhook",
"description": "This is a webhook.",
"externalLink": "",
"admins": [
"admin@company.example"
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List feedback on the given metric
metric feedback filter
Format - int32.
Format - int32.
{
"valueFilter": {
"anomalyValue": "NotAnomaly"
},
"metricId": "22222222-2222-2222-2222-000000000001",
"feedbackType": "Anomaly",
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-01-01T00:00:00.0000000+00:00",
"userPrincipal": "viewer@company.example"
}
Success
{
"@nextLink": "https://localhost/feedback?$skip=1&$top=1",
"value": [
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-01-01T00:00:00.0000000+00:00",
"value": {
"anomalyValue": "NotAnomaly"
},
"sourceInfo": {
"anomalyDetectionConfiguration": {
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
},
"feedbackId": "99999999-9999-9999-9999-000000000001",
"createdTime": "2020-03-01T00:00:00.0000000+00:00",
"userPrincipal": "viewer@company.example",
"metricId": "22222222-2222-2222-2222-000000000001",
"dimensionFilter": {
"dimension": {
"city": "Beijing"
}
},
"feedbackType": "Anomaly"
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Reset data ingestion status by data feed to backfill data
Format - uuid. The data feed unique id
The backfill time range
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00"
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Update anomaly alerting configuration
Format - uuid. anomaly alerting configuration unique id
anomaly alerting configuration
{
"name": "alerting configuration name",
"crossMetricsOperator": "AND",
"hookIds": [
"00000000-0000-0000-0000-000000000001"
],
"metricAlertingConfigurations": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"anomalyScopeType": "All",
"negationOperation": false,
"severityFilter": {
"minAlertSeverity": "Medium",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
}
},
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
"anomalyScopeType": "Dimension",
"negationOperation": false,
"dimensionAnomalyScope": {
"dimension": {
"city": "Beijing"
}
},
"severityFilter": {
"minAlertSeverity": "Low",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
},
"valueFilter": {
"lower": 0,
"upper": 1000,
"direction": "Both",
"triggerForMissing": false
}
}
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Update anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
anomaly detection configuration
{
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Update a data feed
Format - uuid. The data feed unique id
parameters to update a data feed
{
"dataFeedName": "Sample - cost/revenue - city/category (modified)",
"viewers": [
"viewer@company.example"
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Update a hook
Format - uuid. Hook unique ID
Update hook request
{
"hookName": "A webhook (modified)",
"description": "This is a webhook. (modified)"
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create anomaly alerting configuration
anomaly alerting configuration
{
"name": "alerting configuration name",
"crossMetricsOperator": "AND",
"hookIds": [
"00000000-0000-0000-0000-000000000001"
],
"metricAlertingConfigurations": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"anomalyScopeType": "All",
"negationOperation": false,
"severityFilter": {
"minAlertSeverity": "Medium",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
}
},
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
"anomalyScopeType": "Dimension",
"negationOperation": false,
"dimensionAnomalyScope": {
"dimension": {
"city": "Beijing"
}
},
"severityFilter": {
"minAlertSeverity": "Low",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
},
"valueFilter": {
"lower": 0,
"upper": 1000,
"direction": "Both",
"triggerForMissing": false
}
}
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create anomaly detection configuration
anomaly detection configuration
{
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create a new data feed
parameters to create a data feed
{
"dataSourceParameter": {
"connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;",
"query": "select * from your_table where timestamp = @StartTime"
},
"dataFeedName": "Sample - cost/revenue - city/category",
"dataFeedDescription": "This is a sample data feed.",
"granularityName": "Daily",
"metrics": [
{
"metricName": "cost",
"metricDisplayName": "cost"
},
{
"metricName": "revenue",
"metricDisplayName": "revenue"
}
],
"dimension": [
{
"dimensionName": "category",
"dimensionDisplayName": "category"
},
{
"dimensionName": "city",
"dimensionDisplayName": "city"
}
],
"timestampColumn": "timestamp",
"dataStartFrom": "2020-01-01T00:00:00.0000000+00:00",
"dataSourceType": "SqlServer",
"startOffsetInSeconds": 86400,
"maxConcurrency": 5,
"minRetryIntervalInSeconds": 3600,
"stopRetryAfterInSeconds": 604800,
"needRollup": "NeedRollup",
"rollUpMethod": "Sum",
"allUpIdentification": "__SUM__",
"fillMissingPointType": "SmartFilling",
"viewMode": "Private",
"isAdmin": false
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create a new hook
Create hook request
{
"hookParameter": {
"endpoint": "https://localhost/demo/post"
},
"hookName": "A webhook",
"hookType": "Webhook",
"description": "This is a webhook.",
"externalLink": ""
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Create a new metric feedback
metric feedback
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-01-01T00:00:00.0000000+00:00",
"value": {
"anomalyValue": "NotAnomaly"
},
"sourceInfo": {
"anomalyDetectionConfiguration": {
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
},
"metricId": "22222222-2222-2222-2222-000000000001",
"dimensionFilter": {
"dimension": {
"city": "Beijing"
}
},
"feedbackType": "Anomaly"
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Delete anomaly alerting configuration
Format - uuid. anomaly alerting configuration unique id
The resource is deleted successfully or does not exist.
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Delete anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
The resource is deleted successfully or does not exist.
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Delete a data feed
Format - uuid. The data feed unique id
The resource is deleted successfully or does not exist.
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Delete a hook
Format - uuid. Hook unique ID
The resource is deleted successfully or does not exist.
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query alerts under anomaly alerting configuration
Format - uuid. anomaly alerting configuration unique id
query alerting result request
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"timeMode": "AnomalyTime"
}
Success
{
"value": [
{
"alertId": "aaaaaaaaaaaa",
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"createdTime": "2020-07-21T17:26:50.0000000+00:00",
"modifiedTime": "2020-07-21T17:26:50.0000000+00:00"
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query anomalies under anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
query detection anomaly result request
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"filter": {
"dimensionFilter": [
{
"dimension": {
"city": "Beijing"
}
}
],
"severityFilter": {
"min": "Low",
"max": "High"
}
}
}
Success
{
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"createdTime": "2020-07-21T17:26:50.0000000+00:00",
"modifiedTime": "2020-07-21T17:26:50.0000000+00:00",
"dimension": {
"category": "__SUM__",
"city": "Beijing"
},
"property": {
"anomalySeverity": "High",
"anomalyStatus": "Active"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query anomalies under a specific alert
Format - uuid. anomaly alerting configuration unique id
alert id
Format - int32.
Format - int32.
Success
{
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"createdTime": "2020-07-21T17:26:50.0000000+00:00",
"modifiedTime": "2020-07-21T17:26:50.0000000+00:00",
"dimension": {
"category": "__SUM__",
"city": "Beijing"
},
"property": {
"anomalySeverity": "High",
"anomalyStatus": "Active"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query a single anomaly alerting configuration
Format - uuid. anomaly alerting configuration unique id
Success
{
"anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001",
"name": "alerting configuration name",
"crossMetricsOperator": "AND",
"hookIds": [
"00000000-0000-0000-0000-000000000001"
],
"metricAlertingConfigurations": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"anomalyScopeType": "All",
"negationOperation": false,
"severityFilter": {
"minAlertSeverity": "Medium",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
}
},
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
"anomalyScopeType": "Dimension",
"negationOperation": false,
"dimensionAnomalyScope": {
"dimension": {
"city": "Beijing"
}
},
"severityFilter": {
"minAlertSeverity": "Low",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
},
"valueFilter": {
"lower": 0,
"upper": 1000,
"direction": "Both",
"triggerForMissing": false
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query all anomaly alerting configurations for specific anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
Success
{
"value": [
{
"anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001",
"name": "alerting configuration name",
"crossMetricsOperator": "AND",
"hookIds": [
"00000000-0000-0000-0000-000000000001"
],
"metricAlertingConfigurations": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"anomalyScopeType": "All",
"negationOperation": false,
"severityFilter": {
"minAlertSeverity": "Medium",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
}
},
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
"anomalyScopeType": "Dimension",
"negationOperation": false,
"dimensionAnomalyScope": {
"dimension": {
"city": "Beijing"
}
},
"severityFilter": {
"minAlertSeverity": "Low",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
},
"valueFilter": {
"lower": 0,
"upper": 1000,
"direction": "Both",
"triggerForMissing": false
}
}
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query a single anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
Success
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query all anomaly detection configurations for specific metric
Format - uuid. metric unique id
Success
{
"value": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get a data feed by its id
Format - uuid. The data feed unique id
Success
{
"dataSourceParameter": {
"connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;",
"query": "select * from your_table where timestamp = @StartTime"
},
"dataFeedId": "11111111-1111-1111-1111-000000000001",
"dataFeedName": "Sample - cost/revenue - city/category",
"dataFeedDescription": "This is a sample data feed.",
"granularityName": "Daily",
"metrics": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"metricName": "cost",
"metricDisplayName": "cost"
},
{
"metricId": "22222222-2222-2222-2222-000000000002",
"metricName": "revenue",
"metricDisplayName": "revenue"
}
],
"dimension": [
{
"dimensionName": "category",
"dimensionDisplayName": "category"
},
{
"dimensionName": "city",
"dimensionDisplayName": "city"
}
],
"timestampColumn": "timestamp",
"dataStartFrom": "2020-01-01T00:00:00.0000000+00:00",
"dataSourceType": "SqlServer",
"startOffsetInSeconds": 86400,
"maxConcurrency": 5,
"minRetryIntervalInSeconds": 3600,
"stopRetryAfterInSeconds": 604800,
"needRollup": "NeedRollup",
"rollUpMethod": "Sum",
"allUpIdentification": "__SUM__",
"fillMissingPointType": "SmartFilling",
"viewMode": "Private",
"admins": [
"admin@company.example"
],
"viewers": [ ],
"isAdmin": true,
"creator": "admin@company.example",
"status": "Active",
"createdTime": "2020-03-01T00:00:00.0000000+00:00"
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get data ingestion status by data feed
Format - uuid. The data feed unique id
The query time range
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00"
}
Success
{
"@nextLink": "https://localhost/dataFeeds/01234567-8901-2345-6789-012345678901/ingestionStatus/query?$skip=2&$top=2",
"value": [
{
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"status": "Succeeded",
"message": ""
},
{
"timestamp": "2020-01-02T00:00:00.0000000+00:00",
"status": "Succeeded",
"message": ""
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query dimension values of anomalies
Format - uuid. anomaly detection configuration unique id
query dimension values request
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"dimensionName": "category",
"dimensionFilter": {
"dimension": {
"city": "Beijing"
}
}
}
Success
{
"value": [
"Jewelry"
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query anomaly detection status
Format - uuid. metric unique id
query options
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00"
}
Success
{
"@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/status/enrichment/anomalyDetection/query?$skip=2&$top=2",
"value": [
{
"timestamp": "2020-01-01T00:00:00.0000000+00:00",
"status": "Succeeded",
"message": ""
},
{
"timestamp": "2020-01-02T00:00:00.0000000+00:00",
"status": "Succeeded",
"message": ""
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get a hook by its id
Format - uuid. Hook unique ID
Success
{
"hookParameter": {
"endpoint": "https://localhost/demo/post"
},
"hookId": "00000000-0000-0000-0000-000000000001",
"hookName": "A webhook",
"hookType": "Webhook",
"description": "This is a webhook.",
"externalLink": "",
"admins": [
"admin@company.example"
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query incidents under anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
query detection incident result request
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"filter": {
"dimensionFilter": [
{
"dimension": {
"city": "Beijing"
}
}
]
}
}
Success
{
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"incidentId": "iiiiiiiiiiii",
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"lastTime": "2020-02-01T00:00:00.0000000+00:00",
"rootNode": {
"dimension": {
"category": "__SUM__",
"city": "Beijing"
}
},
"property": {
"maxSeverity": "High",
"incidentStatus": "Active"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query incidents under a specific alert
Format - uuid. anomaly alerting configuration unique id
alert id
Format - int32.
Format - int32.
Success
{
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"incidentId": "iiiiiiiiiiii",
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"lastTime": "2020-02-01T00:00:00.0000000+00:00",
"rootNode": {
"dimension": {
"category": "__SUM__",
"city": "Beijing"
}
},
"property": {
"maxSeverity": "High",
"incidentStatus": "Active"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get data last success ingestion job timestamp by data feed
Format - uuid. The data feed unique id
Success
{
"latestSuccessTimestamp": "2020-01-30T00:00:00.0000000+00:00",
"latestActiveTimestamp": "2020-01-31T00:00:00.0000000+00:00"
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get time series data from metric
Format - uuid. metric unique id
query time series data condition
Format - int32.
Format - int32.
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"series": [
{
"category": "__SUM__",
"city": "Beijing"
}
]
}
Success
{
"@nextLink": "https://localhost/metrics/11112222-3333-4444-5555-666677778888/series/data/query?$skip=1&$top=1",
"value": [
{
"id": {
"metricId": "22222222-2222-2222-2222-000000000001",
"dimension": {
"category": "__SUM__",
"city": "Beijing"
}
},
"timestampList": [
"2020-01-01T00:00:00.0000000+00:00",
"2020-01-02T00:00:00.0000000+00:00"
],
"valueList": [
2.71828182845905,
3.14159265358979
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List dimension from certain metric
Format - uuid. metric unique id
query dimension option
Format - int32.
Format - int32.
{
"dimensionName": "city"
}
Success
{
"@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/dimension/query?$skip=2&$top=2",
"value": [
"__SUM__",
"Beijing"
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Get a metric feedback by its id
Format - uuid.
Success
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-01-01T00:00:00.0000000+00:00",
"value": {
"anomalyValue": "NotAnomaly"
},
"sourceInfo": {
"anomalyDetectionConfiguration": {
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
},
"feedbackId": "99999999-9999-9999-9999-000000000001",
"createdTime": "2020-03-01T00:00:00.0000000+00:00",
"userPrincipal": "viewer@company.example",
"metricId": "22222222-2222-2222-2222-000000000001",
"dimensionFilter": {
"dimension": {
"city": "Beijing"
}
},
"feedbackType": "Anomaly"
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List series (dimension combinations) from metric
Format - uuid. metric unique id
filter to query series
Format - int32.
Format - int32.
{
"activeSince": "2020-01-01T00:00:00.0000000+00:00",
"dimensionFilter": {
"city": [
"Beijing"
]
}
}
Success
{
"@nextLink": "https://localhost/metrics/22222222-2222-2222-2222-000000000001/series/dimension/query?$skip=2&$top=2",
"value": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"dimension": {
"category": "__SUM__",
"city": "Beijing"
}
},
{
"metricId": "22222222-2222-2222-2222-000000000001",
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query root cause for incident
Format - uuid. anomaly detection configuration unique id
incident id
Success
{
"value": [
{
"rootCause": {
"dimension": {
"city": "Beijing"
}
},
"path": [
"city"
],
"score": 0.67,
"description": "city = Beijing contributes the most to this anomaly."
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Query series enriched by anomaly detection
Format - uuid. anomaly detection configuration unique id
query series detection result request
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00",
"series": [
{
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
}
]
}
Success
{
"value": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"timestampList": [
"2020-01-01T00:00:00.0000000+00:00"
],
"valueList": [
108.3
],
"isAnomalyList": [
false
],
"periodList": [
0
],
"expectedValueList": [
108
],
"lowerBoundaryList": [
100.1
],
"upperBoundaryList": [
112.8
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List all data feeds
filter data feed by its name
filter data feed by its source type
filter data feed by its granularity
filter data feed by its status
filter data feed by its creator
Format - int32.
Format - int32.
Success
{
"@nextLink": "https://localhost/dataFeeds?$skip=1&$top=1",
"value": [
{
"dataSourceParameter": {
"connectionString": "Server=your_sql_server,1433;Initial Catalog=your_database;Persist Security Info=False;User ID=your_user;Password=your_password;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;",
"query": "select * from your_table where timestamp = @StartTime"
},
"dataFeedId": "11111111-1111-1111-1111-000000000001",
"dataFeedName": "Sample - cost/revenue - city/category",
"dataFeedDescription": "This is a sample data feed.",
"granularityName": "Daily",
"metrics": [
{
"metricId": "22222222-2222-2222-2222-000000000001",
"metricName": "cost",
"metricDisplayName": "cost"
},
{
"metricId": "22222222-2222-2222-2222-000000000002",
"metricName": "revenue",
"metricDisplayName": "revenue"
}
],
"dimension": [
{
"dimensionName": "category",
"dimensionDisplayName": "category"
},
{
"dimensionName": "city",
"dimensionDisplayName": "city"
}
],
"timestampColumn": "timestamp",
"dataStartFrom": "2020-01-01T00:00:00.0000000+00:00",
"dataSourceType": "SqlServer",
"startOffsetInSeconds": 86400,
"maxConcurrency": 5,
"minRetryIntervalInSeconds": 3600,
"stopRetryAfterInSeconds": 604800,
"needRollup": "NeedRollup",
"rollUpMethod": "Sum",
"allUpIdentification": "__SUM__",
"fillMissingPointType": "SmartFilling",
"viewMode": "Private",
"admins": [
"admin@company.example"
],
"viewers": [ ],
"isAdmin": true,
"creator": "admin@company.example",
"status": "Active",
"createdTime": "2020-03-01T00:00:00.0000000+00:00"
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List all hooks
filter hook by its name
Format - int32.
Format - int32.
Success
{
"@nextLink": "https://localhost/hooks?$skip=1&$top=1",
"value": [
{
"hookParameter": {
"endpoint": "https://localhost/demo/post"
},
"hookId": "00000000-0000-0000-0000-000000000001",
"hookName": "A webhook",
"hookType": "Webhook",
"description": "This is a webhook.",
"externalLink": "",
"admins": [
"admin@company.example"
]
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
List feedback on the given metric
metric feedback filter
Format - int32.
Format - int32.
{
"valueFilter": {
"anomalyValue": "NotAnomaly"
},
"metricId": "22222222-2222-2222-2222-000000000001",
"feedbackType": "Anomaly",
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-01-01T00:00:00.0000000+00:00",
"userPrincipal": "viewer@company.example"
}
Success
{
"@nextLink": "https://localhost/feedback?$skip=1&$top=1",
"value": [
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-01-01T00:00:00.0000000+00:00",
"value": {
"anomalyValue": "NotAnomaly"
},
"sourceInfo": {
"anomalyDetectionConfiguration": {
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"metricId": "22222222-2222-2222-2222-000000000001",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
},
"feedbackId": "99999999-9999-9999-9999-000000000001",
"createdTime": "2020-03-01T00:00:00.0000000+00:00",
"userPrincipal": "viewer@company.example",
"metricId": "22222222-2222-2222-2222-000000000001",
"dimensionFilter": {
"dimension": {
"city": "Beijing"
}
},
"feedbackType": "Anomaly"
}
]
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Reset data ingestion status by data feed to backfill data
Format - uuid. The data feed unique id
The backfill time range
{
"startTime": "2020-01-01T00:00:00.0000000+00:00",
"endTime": "2020-02-01T00:00:00.0000000+00:00"
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Update anomaly alerting configuration
Format - uuid. anomaly alerting configuration unique id
anomaly alerting configuration
{
"name": "alerting configuration name",
"crossMetricsOperator": "AND",
"hookIds": [
"00000000-0000-0000-0000-000000000001"
],
"metricAlertingConfigurations": [
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
"anomalyScopeType": "All",
"negationOperation": false,
"severityFilter": {
"minAlertSeverity": "Medium",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
}
},
{
"anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
"anomalyScopeType": "Dimension",
"negationOperation": false,
"dimensionAnomalyScope": {
"dimension": {
"city": "Beijing"
}
},
"severityFilter": {
"minAlertSeverity": "Low",
"maxAlertSeverity": "High"
},
"snoozeFilter": {
"autoSnooze": 0,
"snoozeScope": "Series",
"onlyForSuccessive": true
},
"valueFilter": {
"lower": 0,
"upper": 1000,
"direction": "Both",
"triggerForMissing": false
}
}
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Update anomaly detection configuration
Format - uuid. anomaly detection configuration unique id
anomaly detection configuration
{
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Update a data feed
Format - uuid. The data feed unique id
parameters to update a data feed
{
"dataFeedName": "Sample - cost/revenue - city/category (modified)",
"viewers": [
"viewer@company.example"
]
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Update a hook
Format - uuid. Hook unique ID
Update hook request
{
"hookName": "A webhook (modified)",
"description": "This is a webhook. (modified)"
}
Success
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}