Microsoft Azure Metrics Advisor REST API v1.1-preview.1
Microsoft Azure Metrics Advisor REST API (v1.1-preview.1)
Query series enriched by anomaly detection
Query series enriched by anomaly detection
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
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.
Request body
query series detection result request
{
"startTime": "2020-01-01T00:00:00Z",
"endTime": "2020-02-01T00:00:00Z",
"series": [
{
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
}
]
}
{
"required": [
"endTime",
"series",
"startTime"
],
"type": "object",
"properties": {
"startTime": {
"format": "date-time",
"description": "This is inclusive. The maximum number of data points (series number * time range) is 10000.",
"type": "string"
},
"endTime": {
"format": "date-time",
"description": "This is exclusive. The maximum number of data points (series number * time range) is 10000.",
"type": "string"
},
"series": {
"description": "The series to be queried. The identity must be able to define one single time series instead of a group of time series. The maximum number of series is 100.",
"uniqueItems": true,
"type": "array",
"items": {
"required": [
"dimension"
],
"type": "object",
"properties": {
"dimension": {
"description": "dimension specified for series",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
},
"example": {
"startTime": "2020-01-01T00:00:00Z",
"endTime": "2020-02-01T00:00:00Z",
"series": [
{
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
}
]
}
}
Response 200
Success
{
"value": [
{
"series": {
"dimension": {}
},
"timestampList": [
"string"
],
"valueList": [
0.0
],
"isAnomalyList": [
true
],
"periodList": [
0
],
"expectedValueList": [
0.0
],
"lowerBoundaryList": [
0.0
],
"upperBoundaryList": [
0.0
]
}
]
}
{
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"required": [
"expectedValueList",
"isAnomalyList",
"lowerBoundaryList",
"periodList",
"series",
"timestampList",
"upperBoundaryList",
"valueList"
],
"type": "object",
"properties": {
"series": {
"required": [
"dimension"
],
"type": "object",
"properties": {
"dimension": {
"description": "dimension specified for series",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"timestampList": {
"description": "timestamps of the series",
"type": "array",
"items": {
"format": "date-time",
"type": "string"
}
},
"valueList": {
"description": "values of the series",
"type": "array",
"items": {
"format": "double",
"type": "number"
}
},
"isAnomalyList": {
"description": "whether points of the series are anomalies",
"type": "array",
"items": {
"type": "boolean"
}
},
"periodList": {
"description": "period calculated on each point of the series",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"expectedValueList": {
"description": "expected values of the series given by smart detector",
"type": "array",
"items": {
"format": "double",
"type": "number"
}
},
"lowerBoundaryList": {
"description": "lower boundary list of the series given by smart detector",
"type": "array",
"items": {
"format": "double",
"type": "number"
}
},
"upperBoundaryList": {
"description": "upper boundary list of the series given by smart detector",
"type": "array",
"items": {
"format": "double",
"type": "number"
}
}
}
}
}
}
}
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 POST "https://westus3.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/enrichment/anomalyDetection/configurations/{configurationId}/series/query"
-H "Content-Type: application/json"
-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://westus3.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/enrichment/anomalyDetection/configurations/{configurationId}/series/query?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
}
// // 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://westus3.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/enrichment/anomalyDetection/configurations/{configurationId}/series/query");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json");
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://westus3.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/enrichment/anomalyDetection/configurations/{configurationId}/series/query?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// 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://westus3.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/enrichment/anomalyDetection/configurations/{configurationId}/series/query";
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:@"POST"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_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://westus3.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/enrichment/anomalyDetection/configurations/{configurationId}/series/query');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// 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
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('westus3.api.cognitive.microsoft.com')
conn.request("POST", "/metricsadvisor/v1.1-preview.1/enrichment/anomalyDetection/configurations/{configurationId}/series/query?%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
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('westus3.api.cognitive.microsoft.com')
conn.request("POST", "/metricsadvisor/v1.1-preview.1/enrichment/anomalyDetection/configurations/{configurationId}/series/query?%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://westus3.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/enrichment/anomalyDetection/configurations/{configurationId}/series/query')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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