Microsoft Azure Metrics Advisor REST API v1.1-preview.1

Microsoft Azure Metrics Advisor REST API (v1.1-preview.1)

Get a time series group

Get a time series group

Select the testing console in the region where you created your resource:

Open API testing console

Request URL

Request parameters

string

Format - uuid. time series group unique id

Request headers

string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Response 200

Success

{
  "groupId": "string",
  "name": "string",
  "description": "",
  "status": "Active",
  "creator": "string",
  "isAdmin": false,
  "createdTime": "string",
  "seriesSets": [
    {
      "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"
        }
      ]
    }
  ],
  "appInstances": [
    {
      "instanceName": "Sample Analysis Group Application Instance Name",
      "appId": "11111111-1111-1111-1111-000000000002",
      "parameters": {
        "params1": 1,
        "params2": "two"
      },
      "hookIds": [
        "00000000-0000-0000-0000-000000000001"
      ]
    }
  ],
  "admins": [
    "string"
  ],
  "viewers": [
    "string"
  ]
}
{
  "required": [
    "admins",
    "appInstances",
    "name",
    "seriesSets"
  ],
  "type": "object",
  "properties": {
    "groupId": {
      "format": "uuid",
      "description": "Time series group unique ID",
      "type": "string"
    },
    "name": {
      "description": "Time series group name",
      "type": "string"
    },
    "description": {
      "description": "Time series group description",
      "default": "",
      "type": "string"
    },
    "status": {
      "description": "Time series group status",
      "default": "Active",
      "enum": [
        "Active",
        "Paused"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "EntityStatus",
        "modelAsString": true
      }
    },
    "creator": {
      "description": "Time series group creator",
      "type": "string"
    },
    "isAdmin": {
      "description": "Flag stands for visitor is administrator of time series group or not",
      "default": false,
      "type": "boolean"
    },
    "createdTime": {
      "format": "date-time",
      "description": "Time series group created date time",
      "type": "string"
    },
    "seriesSets": {
      "description": "List of series sets",
      "uniqueItems": true,
      "type": "array",
      "items": {
        "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"
            }
          ]
        }
      }
    },
    "appInstances": {
      "description": "List of application instances",
      "uniqueItems": true,
      "type": "array",
      "items": {
        "required": [
          "appId",
          "hookIds",
          "instanceName",
          "parameters"
        ],
        "type": "object",
        "properties": {
          "instanceId": {
            "format": "uuid",
            "description": "Time series group application instance unique id",
            "type": "string"
          },
          "instanceName": {
            "description": "Time series group application instance name",
            "type": "string"
          },
          "appId": {
            "format": "uuid",
            "description": "Time series group application unique id",
            "type": "string"
          },
          "appName": {
            "description": "Time series group application name",
            "type": "string"
          },
          "appDisplayName": {
            "description": "Time series group application display name",
            "type": "string"
          },
          "appType": {
            "description": "Time series group application type",
            "default": "External",
            "enum": [
              "Internal",
              "External"
            ],
            "type": "string",
            "x-ms-enum": {
              "name": "TimeSeriesGroupAppType",
              "modelAsString": true
            }
          },
          "remoteModelKey": {
            "format": "uuid",
            "description": "Time series group application instance model key",
            "type": "string"
          },
          "remoteCandidateModelKey": {
            "format": "uuid",
            "description": "Time series group application instance candidate model key",
            "type": "string"
          },
          "parameters": {
            "description": "Time series group application instance parameters",
            "type": "object"
          },
          "hookIds": {
            "description": "Time series group application instance associated hook unique ids",
            "uniqueItems": true,
            "type": "array",
            "items": {
              "format": "uuid",
              "type": "string"
            }
          },
          "status": {
            "description": "Time series group application instance status",
            "enum": [
              "Active",
              "Deleted"
            ],
            "type": "string",
            "x-ms-enum": {
              "name": "TimeSeriesGroupEntityStatus",
              "modelAsString": true
            }
          }
        },
        "example": {
          "instanceName": "Sample Analysis Group Application Instance Name",
          "appId": "11111111-1111-1111-1111-000000000002",
          "parameters": {
            "params1": 1,
            "params2": "two"
          },
          "hookIds": [
            "00000000-0000-0000-0000-000000000001"
          ]
        }
      }
    },
    "admins": {
      "description": "Time series group administrator group",
      "uniqueItems": true,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "viewers": {
      "description": "Time series group viewer group",
      "uniqueItems": true,
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

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.1-preview.1/timeSeriesGroups/{groupId}"
-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.1-preview.1/timeSeriesGroups/{groupId}?" + 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.1-preview.1/timeSeriesGroups/{groupId}");


            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.1-preview.1/timeSeriesGroups/{groupId}?" + $.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.1-preview.1/timeSeriesGroups/{groupId}";
    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.1-preview.1/timeSeriesGroups/{groupId}');
$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.1-preview.1/timeSeriesGroups/{groupId}?%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.1-preview.1/timeSeriesGroups/{groupId}?%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.1-preview.1/timeSeriesGroups/{groupId}')
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