Microsoft Azure Metrics Advisor REST API

Microsoft Azure Metrics Advisor REST API

Get a data feed by its id

Get a data feed by its id

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

Open API testing console

Request URL

Request parameters

string

Format - uuid. The data feed unique id

Request headers

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

Request body

Response 200

Success

{
  "dataSourceParameter": {
    "connectionString": "Server=PlaceholderSqlServer,1433;Initial Catalog=PlaceholderDatabase;User ID=PlaceholderUserName;Password=PlaceholderPassword;",
    "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:00Z",
  "dataSourceType": "SqlServer",
  "startOffsetInSeconds": 86400,
  "maxConcurrency": 5,
  "minRetryIntervalInSeconds": 3600,
  "stopRetryAfterInSeconds": 604800,
  "needRollup": "NeedRollup",
  "rollUpMethod": "Sum",
  "allUpIdentification": "__SUM__",
  "fillMissingPointType": "SmartFilling",
  "viewMode": "Private",
  "authenticationType": "Basic"
}
{
  "required": [
    "dataFeedName",
    "dataSourceType",
    "dataStartFrom",
    "granularityName",
    "metrics"
  ],
  "type": "object",
  "properties": {
    "dataSourceType": {
      "description": "data source type",
      "enum": [
        "AzureApplicationInsights",
        "AzureBlob",
        "AzureCosmosDB",
        "AzureDataExplorer",
        "AzureDataLakeStorageGen2",
        "AzureEventHubs",
        "AzureLogAnalytics",
        "AzureTable",
        "InfluxDB",
        "MongoDB",
        "MySql",
        "PostgreSql",
        "SqlServer"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "DataSourceType",
        "modelAsString": true
      }
    },
    "dataFeedId": {
      "format": "uuid",
      "description": "data feed unique id",
      "type": "string",
      "readOnly": true
    },
    "dataFeedName": {
      "description": "data feed name",
      "type": "string",
      "example": "dummy data feed name"
    },
    "dataFeedDescription": {
      "description": "data feed description",
      "default": "",
      "type": "string"
    },
    "granularityName": {
      "description": "granularity of the time series",
      "enum": [
        "Yearly",
        "Monthly",
        "Weekly",
        "Daily",
        "Hourly",
        "Minutely",
        "Secondly",
        "Custom"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "Granularity",
        "modelAsString": true
      }
    },
    "granularityAmount": {
      "format": "int32",
      "description": "if granularity is custom,it is required.",
      "type": "integer"
    },
    "metrics": {
      "description": "measure list",
      "uniqueItems": true,
      "type": "array",
      "items": {
        "required": [
          "metricName"
        ],
        "type": "object",
        "properties": {
          "metricId": {
            "format": "uuid",
            "description": "metric id",
            "type": "string",
            "readOnly": true
          },
          "metricName": {
            "description": "metric name",
            "type": "string"
          },
          "metricDisplayName": {
            "description": "metric display name",
            "pattern": "[.a-zA-Z0-9_-]+",
            "type": "string"
          },
          "metricDescription": {
            "description": "metric description",
            "type": "string"
          }
        }
      }
    },
    "dimension": {
      "description": "dimension list",
      "uniqueItems": true,
      "type": "array",
      "items": {
        "required": [
          "dimensionName"
        ],
        "type": "object",
        "properties": {
          "dimensionName": {
            "description": "dimension name",
            "type": "string"
          },
          "dimensionDisplayName": {
            "description": "dimension display name",
            "pattern": "[.a-zA-Z0-9_-]+",
            "type": "string"
          }
        }
      }
    },
    "timestampColumn": {
      "description": "user-defined timestamp column. if timestampColumn is null, start time of every time slice will be used as default value.",
      "default": "",
      "type": "string"
    },
    "dataStartFrom": {
      "format": "date-time",
      "description": "ingestion start time",
      "type": "string"
    },
    "startOffsetInSeconds": {
      "format": "int64",
      "description": "the time that the beginning of data ingestion task will delay for every data slice according to this offset.",
      "default": 0,
      "type": "integer"
    },
    "maxConcurrency": {
      "format": "int32",
      "description": "the max concurrency of data ingestion queries against user data source. 0 means no limitation.",
      "default": -1,
      "type": "integer"
    },
    "minRetryIntervalInSeconds": {
      "format": "int64",
      "description": "the min retry interval for failed data ingestion tasks.",
      "default": -1,
      "type": "integer"
    },
    "stopRetryAfterInSeconds": {
      "format": "int64",
      "description": "stop retry data ingestion after the data slice first schedule time in seconds.",
      "default": -1,
      "type": "integer"
    },
    "needRollup": {
      "description": "mark if the data feed need rollup",
      "default": "NoRollup",
      "enum": [
        "NoRollup",
        "NeedRollup",
        "AlreadyRollup"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "NeedRollupEnum",
        "modelAsString": true
      }
    },
    "rollUpMethod": {
      "description": "roll up method",
      "default": "None",
      "enum": [
        "None",
        "Sum",
        "Max",
        "Min",
        "Avg",
        "Count"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "RollUpMethod",
        "modelAsString": true
      }
    },
    "rollUpColumns": {
      "description": "roll up columns",
      "uniqueItems": true,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "allUpIdentification": {
      "description": "the identification value for the row of calculated all-up value.",
      "type": "string"
    },
    "fillMissingPointType": {
      "description": "the type of fill missing point for anomaly detection",
      "default": "SmartFilling",
      "enum": [
        "SmartFilling",
        "PreviousValue",
        "CustomValue",
        "NoFilling"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "FillMissingPointType",
        "modelAsString": true
      }
    },
    "fillMissingPointValue": {
      "format": "double",
      "description": "the value of fill missing point for anomaly detection",
      "type": "number"
    },
    "viewMode": {
      "description": "data feed access mode, default is Private",
      "default": "Private",
      "enum": [
        "Private",
        "Public"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "ViewMode",
        "modelAsString": true
      }
    },
    "admins": {
      "description": "data feed administrator",
      "uniqueItems": true,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "viewers": {
      "description": "data feed viewer",
      "uniqueItems": true,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "isAdmin": {
      "description": "the query user is one of data feed administrator or not",
      "type": "boolean",
      "readOnly": true
    },
    "creator": {
      "description": "data feed creator",
      "type": "string",
      "readOnly": true
    },
    "status": {
      "description": "data feed status",
      "enum": [
        "Active",
        "Paused"
      ],
      "type": "string",
      "readOnly": true,
      "x-ms-enum": {
        "name": "EntityStatus",
        "modelAsString": true
      }
    },
    "createdTime": {
      "format": "date-time",
      "description": "data feed created time",
      "type": "string",
      "readOnly": true
    },
    "actionLinkTemplate": {
      "description": "action link for alert",
      "default": "",
      "type": "string"
    },
    "authenticationType": {
      "description": "authentication type for corresponding data source",
      "default": "Basic",
      "enum": [
        "Basic",
        "ManagedIdentity",
        "AzureSQLConnectionString",
        "DataLakeGen2SharedKey",
        "ServicePrincipal",
        "ServicePrincipalInKV"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "AuthenticationTypeEnum",
        "modelAsString": true
      }
    },
    "credentialId": {
      "description": "The credential entity id",
      "type": "string"
    }
  },
  "discriminator": "dataSourceType",
  "example": {
    "dataSourceParameter": {
      "connectionString": "Server=PlaceholderSqlServer,1433;Initial Catalog=PlaceholderDatabase;User ID=PlaceholderUserName;Password=PlaceholderPassword;",
      "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:00Z",
    "dataSourceType": "SqlServer",
    "startOffsetInSeconds": 86400,
    "maxConcurrency": 5,
    "minRetryIntervalInSeconds": 3600,
    "stopRetryAfterInSeconds": 604800,
    "needRollup": "NeedRollup",
    "rollUpMethod": "Sum",
    "allUpIdentification": "__SUM__",
    "fillMissingPointType": "SmartFilling",
    "viewMode": "Private",
    "authenticationType": "Basic"
  }
}

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://westus.api.cognitive.microsoft.com/metricsadvisor/v1.0/dataFeeds/{dataFeedId}"
-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://westus.api.cognitive.microsoft.com/metricsadvisor/v1.0/dataFeeds/{dataFeedId}?" + 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://westus.api.cognitive.microsoft.com/metricsadvisor/v1.0/dataFeeds/{dataFeedId}");


            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://westus.api.cognitive.microsoft.com/metricsadvisor/v1.0/dataFeeds/{dataFeedId}?" + $.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://westus.api.cognitive.microsoft.com/metricsadvisor/v1.0/dataFeeds/{dataFeedId}";
    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://westus.api.cognitive.microsoft.com/metricsadvisor/v1.0/dataFeeds/{dataFeedId}');
$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('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/metricsadvisor/v1.0/dataFeeds/{dataFeedId}?%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('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/metricsadvisor/v1.0/dataFeeds/{dataFeedId}?%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://westus.api.cognitive.microsoft.com/metricsadvisor/v1.0/dataFeeds/{dataFeedId}')
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