Microsoft Azure Metrics Advisor REST API v1.1-preview.1
Microsoft Azure Metrics Advisor REST API (v1.1-preview.1)
Add a time series set to a time series group
Add a time series set to a time series group
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request parameters
string
Format - uuid. Time series group 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
add time series set request
{
"seriesSetName": "Sample Analysis Group Series Set Name",
"metricId": "22222222-2222-2222-2222-000000000001",
"dimensionFilter": {
"category": "Jewelry",
"city": "Beijing"
},
"enrichmentConfigs": [
{
"enrichmentName": "Sample Enrichment Config",
"enrichmentConfigId": "66666666-6666-6666-6666-666666666666"
}
]
}{
"required": [
"dimensionFilter",
"enrichmentConfigs",
"metricId",
"seriesSetName"
],
"type": "object",
"properties": {
"seriesSetId": {
"format": "uuid",
"description": "Series set unique ID",
"type": "string",
"readOnly": true
},
"seriesSetName": {
"description": "Series set name",
"type": "string"
},
"metricId": {
"format": "uuid",
"description": "Metric ID",
"type": "string"
},
"dimensionFilter": {
"description": "Dimension filters to define a time series set",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"metricMeta": {
"required": [
"dataFeedId",
"dataFeedName",
"dataStartFrom",
"granularityName",
"metricName"
],
"type": "object",
"properties": {
"dataFeedId": {
"format": "uuid",
"description": "Data feed unique ID",
"type": "string"
},
"dataFeedName": {
"description": "Data feed name",
"type": "string"
},
"metricName": {
"description": "metric name",
"type": "string"
},
"granularityName": {
"description": "Data feed granularity",
"type": "string"
},
"granularityAmount": {
"format": "int64",
"description": "Data feed granularity in seconds when granularity is Custom",
"type": "integer",
"readOnly": true
},
"dataStartFrom": {
"format": "date-time",
"description": "Data feed start time",
"type": "string"
}
}
},
"enrichmentConfigs": {
"description": "Enrichment configuration",
"uniqueItems": true,
"type": "array",
"items": {
"required": [
"enrichmentConfigId",
"enrichmentName"
],
"type": "object",
"properties": {
"enrichmentName": {
"description": "enrichment config name",
"type": "string"
},
"enrichmentConfigId": {
"format": "uuid",
"description": "enrichment config id",
"type": "string"
}
}
}
}
},
"example": {
"seriesSetName": "Sample Analysis Group Series Set Name",
"metricId": "22222222-2222-2222-2222-000000000001",
"dimensionFilter": {
"category": "Jewelry",
"city": "Beijing"
},
"enrichmentConfigs": [
{
"enrichmentName": "Sample Enrichment Config",
"enrichmentConfigId": "66666666-6666-6666-6666-666666666666"
}
]
}
}Response 201
Success
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://virginia.api.cognitive.microsoft.us/metricsadvisor/v1.1-preview.1/timeSeriesGroups/{groupId}/seriesSets"
-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://virginia.api.cognitive.microsoft.us/metricsadvisor/v1.1-preview.1/timeSeriesGroups/{groupId}/seriesSets?" + 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://virginia.api.cognitive.microsoft.us/metricsadvisor/v1.1-preview.1/timeSeriesGroups/{groupId}/seriesSets");
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://virginia.api.cognitive.microsoft.us/metricsadvisor/v1.1-preview.1/timeSeriesGroups/{groupId}/seriesSets?" + $.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://virginia.api.cognitive.microsoft.us/metricsadvisor/v1.1-preview.1/timeSeriesGroups/{groupId}/seriesSets";
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://virginia.api.cognitive.microsoft.us/metricsadvisor/v1.1-preview.1/timeSeriesGroups/{groupId}/seriesSets');
$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('virginia.api.cognitive.microsoft.us')
conn.request("POST", "/metricsadvisor/v1.1-preview.1/timeSeriesGroups/{groupId}/seriesSets?%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('virginia.api.cognitive.microsoft.us')
conn.request("POST", "/metricsadvisor/v1.1-preview.1/timeSeriesGroups/{groupId}/seriesSets?%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://virginia.api.cognitive.microsoft.us/metricsadvisor/v1.1-preview.1/timeSeriesGroups/{groupId}/seriesSets')
uri.query = URI.encode_www_form({
})
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