Microsoft Azure Metrics Advisor REST API
Microsoft Azure Metrics Advisor REST API
Query a single anomaly detection configuration
Query a single anomaly detection configuration
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request parameters
string
Format - uuid. anomaly detection configuration unique id
Request headers
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.
Request body
Response 200
Success
{
"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
}
}
}
]
}{
"required": [
"metricId",
"name",
"wholeMetricConfiguration"
],
"type": "object",
"properties": {
"anomalyDetectionConfigurationId": {
"format": "uuid",
"description": "anomaly detection configuration unique id",
"type": "string",
"readOnly": true
},
"name": {
"description": "anomaly detection configuration name",
"type": "string"
},
"description": {
"description": "anomaly detection configuration description",
"default": "",
"type": "string"
},
"metricId": {
"format": "uuid",
"description": "metric unique id",
"type": "string"
},
"wholeMetricConfiguration": {
"type": "object",
"properties": {
"conditionOperator": {
"description": "condition operator\r\n\r\nshould be specified when combining multiple detection conditions",
"enum": [
"AND",
"OR"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectionConfigurationLogicType",
"modelAsString": true
}
},
"smartDetectionCondition": {
"required": [
"anomalyDetectorDirection",
"sensitivity",
"suppressCondition"
],
"type": "object",
"properties": {
"sensitivity": {
"format": "double",
"description": "sensitivity, value range : (0, 100]",
"type": "number"
},
"anomalyDetectorDirection": {
"description": "detection direction",
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"format": "int32",
"description": "min point number, value range : [1, +∞)",
"type": "integer"
},
"minRatio": {
"format": "double",
"description": "min point ratio, value range : (0, 100]",
"type": "number"
}
}
}
}
},
"hardThresholdCondition": {
"required": [
"anomalyDetectorDirection",
"suppressCondition"
],
"type": "object",
"properties": {
"lowerBound": {
"format": "double",
"description": "lower bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Down",
"type": "number"
},
"upperBound": {
"format": "double",
"description": "upper bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Up",
"type": "number"
},
"anomalyDetectorDirection": {
"description": "detection direction",
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"format": "int32",
"description": "min point number, value range : [1, +∞)",
"type": "integer"
},
"minRatio": {
"format": "double",
"description": "min point ratio, value range : (0, 100]",
"type": "number"
}
}
}
}
},
"changeThresholdCondition": {
"required": [
"anomalyDetectorDirection",
"changePercentage",
"shiftPoint",
"suppressCondition",
"withinRange"
],
"type": "object",
"properties": {
"changePercentage": {
"format": "double",
"description": "change percentage, value range : [0, +∞)",
"type": "number"
},
"shiftPoint": {
"format": "int32",
"description": "shift point, value range : [1, +∞)",
"type": "integer"
},
"withinRange": {
"description": "if the withinRange = true, detected data is abnormal when the value falls in the range, in this case anomalyDetectorDirection must be Both\r\nif the withinRange = false, detected data is abnormal when the value falls out of the range",
"type": "boolean"
},
"anomalyDetectorDirection": {
"description": "detection direction",
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"format": "int32",
"description": "min point number, value range : [1, +∞)",
"type": "integer"
},
"minRatio": {
"format": "double",
"description": "min point ratio, value range : (0, 100]",
"type": "number"
}
}
}
}
}
}
},
"dimensionGroupOverrideConfigurations": {
"description": "detection configuration for series group",
"uniqueItems": true,
"type": "array",
"items": {
"required": [
"group"
],
"type": "object",
"properties": {
"group": {
"required": [
"dimension"
],
"type": "object",
"properties": {
"dimension": {
"description": "dimension specified for series group",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"conditionOperator": {
"description": "condition operator\r\n\r\nshould be specified when combining multiple detection conditions",
"enum": [
"AND",
"OR"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectionConfigurationLogicType",
"modelAsString": true
}
},
"smartDetectionCondition": {
"required": [
"anomalyDetectorDirection",
"sensitivity",
"suppressCondition"
],
"type": "object",
"properties": {
"sensitivity": {
"format": "double",
"description": "sensitivity, value range : (0, 100]",
"type": "number"
},
"anomalyDetectorDirection": {
"description": "detection direction",
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"format": "int32",
"description": "min point number, value range : [1, +∞)",
"type": "integer"
},
"minRatio": {
"format": "double",
"description": "min point ratio, value range : (0, 100]",
"type": "number"
}
}
}
}
},
"hardThresholdCondition": {
"required": [
"anomalyDetectorDirection",
"suppressCondition"
],
"type": "object",
"properties": {
"lowerBound": {
"format": "double",
"description": "lower bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Down",
"type": "number"
},
"upperBound": {
"format": "double",
"description": "upper bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Up",
"type": "number"
},
"anomalyDetectorDirection": {
"description": "detection direction",
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"format": "int32",
"description": "min point number, value range : [1, +∞)",
"type": "integer"
},
"minRatio": {
"format": "double",
"description": "min point ratio, value range : (0, 100]",
"type": "number"
}
}
}
}
},
"changeThresholdCondition": {
"required": [
"anomalyDetectorDirection",
"changePercentage",
"shiftPoint",
"suppressCondition",
"withinRange"
],
"type": "object",
"properties": {
"changePercentage": {
"format": "double",
"description": "change percentage, value range : [0, +∞)",
"type": "number"
},
"shiftPoint": {
"format": "int32",
"description": "shift point, value range : [1, +∞)",
"type": "integer"
},
"withinRange": {
"description": "if the withinRange = true, detected data is abnormal when the value falls in the range, in this case anomalyDetectorDirection must be Both\r\nif the withinRange = false, detected data is abnormal when the value falls out of the range",
"type": "boolean"
},
"anomalyDetectorDirection": {
"description": "detection direction",
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"format": "int32",
"description": "min point number, value range : [1, +∞)",
"type": "integer"
},
"minRatio": {
"format": "double",
"description": "min point ratio, value range : (0, 100]",
"type": "number"
}
}
}
}
}
}
}
},
"seriesOverrideConfigurations": {
"description": "detection configuration for specific series",
"uniqueItems": true,
"type": "array",
"items": {
"required": [
"series"
],
"type": "object",
"properties": {
"series": {
"required": [
"dimension"
],
"type": "object",
"properties": {
"dimension": {
"description": "dimension specified for series",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"conditionOperator": {
"description": "condition operator\r\n\r\nshould be specified when combining multiple detection conditions",
"enum": [
"AND",
"OR"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectionConfigurationLogicType",
"modelAsString": true
}
},
"smartDetectionCondition": {
"required": [
"anomalyDetectorDirection",
"sensitivity",
"suppressCondition"
],
"type": "object",
"properties": {
"sensitivity": {
"format": "double",
"description": "sensitivity, value range : (0, 100]",
"type": "number"
},
"anomalyDetectorDirection": {
"description": "detection direction",
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"format": "int32",
"description": "min point number, value range : [1, +∞)",
"type": "integer"
},
"minRatio": {
"format": "double",
"description": "min point ratio, value range : (0, 100]",
"type": "number"
}
}
}
}
},
"hardThresholdCondition": {
"required": [
"anomalyDetectorDirection",
"suppressCondition"
],
"type": "object",
"properties": {
"lowerBound": {
"format": "double",
"description": "lower bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Down",
"type": "number"
},
"upperBound": {
"format": "double",
"description": "upper bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Up",
"type": "number"
},
"anomalyDetectorDirection": {
"description": "detection direction",
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"format": "int32",
"description": "min point number, value range : [1, +∞)",
"type": "integer"
},
"minRatio": {
"format": "double",
"description": "min point ratio, value range : (0, 100]",
"type": "number"
}
}
}
}
},
"changeThresholdCondition": {
"required": [
"anomalyDetectorDirection",
"changePercentage",
"shiftPoint",
"suppressCondition",
"withinRange"
],
"type": "object",
"properties": {
"changePercentage": {
"format": "double",
"description": "change percentage, value range : [0, +∞)",
"type": "number"
},
"shiftPoint": {
"format": "int32",
"description": "shift point, value range : [1, +∞)",
"type": "integer"
},
"withinRange": {
"description": "if the withinRange = true, detected data is abnormal when the value falls in the range, in this case anomalyDetectorDirection must be Both\r\nif the withinRange = false, detected data is abnormal when the value falls out of the range",
"type": "boolean"
},
"anomalyDetectorDirection": {
"description": "detection direction",
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"format": "int32",
"description": "min point number, value range : [1, +∞)",
"type": "integer"
},
"minRatio": {
"format": "double",
"description": "min point ratio, value range : (0, 100]",
"type": "number"
}
}
}
}
}
}
}
}
},
"example": {
"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
}
}
}
]
}
}Response 500
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": "string"
}{
"type": "object",
"properties": {
"message": {
"type": "string"
},
"code": {
"type": "string"
}
}
}Code samples
@ECHO OFF
curl -v -X GET "https://*.cognitiveservices.azure.com/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://*.cognitiveservices.azure.com/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://*.cognitiveservices.azure.com/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://*.cognitiveservices.azure.com/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://*.cognitiveservices.azure.com/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://*.cognitiveservices.azure.com/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://*.cognitiveservices.azure.com/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}')
uri.query = URI.encode_www_form({
})
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body