Custom_Vision_Admin_1.1

GetTrainingUsageForOxford

Get usage for training resource for Oxford user

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

West US 2 East US East US 2 South Central US West Europe North Europe Southeast Asia Australia East Central India UK South Japan East North Central US Central US EUAP

Request URL

Request parameters

string

Request headers

string

API key.

string
Subscription key which provides access to this API. Found in your Profile.

Request body

Response 200

OK

{
  "Tier": "string",
  "Projects": {
    "Total": 0,
    "Used": 0
  },
  "PerProjectQuota": [
    {
      "ProjectId": "string",
      "Iterations": {
        "Total": 0,
        "Used": 0
      },
      "Images": {
        "Total": 0,
        "Used": 0
      },
      "Tags": {
        "Total": 0,
        "Used": 0
      }
    }
  ],
  "DailyUsage": [
    {
      "Date": "string",
      "StoredImages": 0,
      "TrainedImages": 0,
      "UploadedImages": 0,
      "QuickTests": 0,
      "TrainingTimeInMs": 0
    }
  ]
}
{
  "description": "Represents a set of quotas assocated with an account.",
  "type": "object",
  "properties": {
    "Tier": {
      "description": "Gets the tier of user.",
      "type": "string",
      "readOnly": false,
      "x-nullable": false
    },
    "Projects": {
      "description": "Gets the project quota.",
      "type": "object",
      "properties": {
        "Total": {
          "format": "int32",
          "description": "The total allowable amount in the quota.",
          "type": "integer",
          "readOnly": false,
          "x-nullable": false
        },
        "Used": {
          "format": "int32",
          "description": "The amount of quota that has currently been used.",
          "type": "integer",
          "readOnly": false,
          "x-nullable": false
        }
      },
      "readOnly": false
    },
    "PerProjectQuota": {
      "description": "Gets a list of quotas that apply per-project for each project.",
      "type": "array",
      "items": {
        "description": "Represents a set of quotas for a given project.",
        "type": "object",
        "properties": {
          "ProjectId": {
            "format": "uuid",
            "description": "Gets the project id of the project this quota applies to.",
            "type": "string",
            "readOnly": false,
            "x-nullable": false
          },
          "Iterations": {
            "description": "Gets the iteration quota for the project.",
            "type": "object",
            "properties": {
              "Total": {
                "format": "int32",
                "description": "The total allowable amount in the quota.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              },
              "Used": {
                "format": "int32",
                "description": "The amount of quota that has currently been used.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              }
            },
            "readOnly": false
          },
          "Images": {
            "description": "Gets the image quota for the project.",
            "type": "object",
            "properties": {
              "Total": {
                "format": "int32",
                "description": "The total allowable amount in the quota.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              },
              "Used": {
                "format": "int32",
                "description": "The amount of quota that has currently been used.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              }
            },
            "readOnly": false
          },
          "Tags": {
            "description": "Gets the tag quota for the project.",
            "type": "object",
            "properties": {
              "Total": {
                "format": "int32",
                "description": "The total allowable amount in the quota.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              },
              "Used": {
                "format": "int32",
                "description": "The amount of quota that has currently been used.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              }
            },
            "readOnly": false
          }
        },
        "x-nullable": false
      },
      "readOnly": false
    },
    "DailyUsage": {
      "description": "Get a list of billing usage by day.",
      "type": "array",
      "items": {
        "description": "Represents the usage for billing purpose in one day",
        "type": "object",
        "properties": {
          "Date": {
            "description": "Represent the date of the usage",
            "type": "string",
            "readOnly": false,
            "x-nullable": false
          },
          "StoredImages": {
            "format": "int32",
            "description": "Gets the peak number of stored images in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          },
          "TrainedImages": {
            "format": "int32",
            "description": "Gets the total number of images used in training in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          },
          "UploadedImages": {
            "format": "int32",
            "description": "Gets the total number of images uploaded to service in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          },
          "QuickTests": {
            "format": "int32",
            "description": "Gets the total number of quicktests in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          },
          "TrainingTimeInMs": {
            "format": "int32",
            "description": "Gets the total training time in milliseconds in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          }
        },
        "x-nullable": false
      },
      "readOnly": false
    }
  }
}
<TrainingUsageModel>
  <Tier>string</Tier>
  <Projects>
    <Total>0</Total>
    <Used>0</Used>
  </Projects>
  <PerProjectQuota>
    <ProjectId>string</ProjectId>
    <Iterations>
      <Total>0</Total>
      <Used>0</Used>
    </Iterations>
    <Images>
      <Total>0</Total>
      <Used>0</Used>
    </Images>
    <Tags>
      <Total>0</Total>
      <Used>0</Used>
    </Tags>
  </PerProjectQuota>
  <DailyUsage>
    <Date>string</Date>
    <StoredImages>0</StoredImages>
    <TrainedImages>0</TrainedImages>
    <UploadedImages>0</UploadedImages>
    <QuickTests>0</QuickTests>
    <TrainingTimeInMs>0</TrainingTimeInMs>
  </DailyUsage>
</TrainingUsageModel>
{
  "description": "Represents a set of quotas assocated with an account.",
  "type": "object",
  "properties": {
    "Tier": {
      "description": "Gets the tier of user.",
      "type": "string",
      "readOnly": false,
      "x-nullable": false
    },
    "Projects": {
      "description": "Gets the project quota.",
      "type": "object",
      "properties": {
        "Total": {
          "format": "int32",
          "description": "The total allowable amount in the quota.",
          "type": "integer",
          "readOnly": false,
          "x-nullable": false
        },
        "Used": {
          "format": "int32",
          "description": "The amount of quota that has currently been used.",
          "type": "integer",
          "readOnly": false,
          "x-nullable": false
        }
      },
      "readOnly": false
    },
    "PerProjectQuota": {
      "description": "Gets a list of quotas that apply per-project for each project.",
      "type": "array",
      "items": {
        "description": "Represents a set of quotas for a given project.",
        "type": "object",
        "properties": {
          "ProjectId": {
            "format": "uuid",
            "description": "Gets the project id of the project this quota applies to.",
            "type": "string",
            "readOnly": false,
            "x-nullable": false
          },
          "Iterations": {
            "description": "Gets the iteration quota for the project.",
            "type": "object",
            "properties": {
              "Total": {
                "format": "int32",
                "description": "The total allowable amount in the quota.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              },
              "Used": {
                "format": "int32",
                "description": "The amount of quota that has currently been used.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              }
            },
            "readOnly": false
          },
          "Images": {
            "description": "Gets the image quota for the project.",
            "type": "object",
            "properties": {
              "Total": {
                "format": "int32",
                "description": "The total allowable amount in the quota.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              },
              "Used": {
                "format": "int32",
                "description": "The amount of quota that has currently been used.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              }
            },
            "readOnly": false
          },
          "Tags": {
            "description": "Gets the tag quota for the project.",
            "type": "object",
            "properties": {
              "Total": {
                "format": "int32",
                "description": "The total allowable amount in the quota.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              },
              "Used": {
                "format": "int32",
                "description": "The amount of quota that has currently been used.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              }
            },
            "readOnly": false
          }
        },
        "x-nullable": false
      },
      "readOnly": false
    },
    "DailyUsage": {
      "description": "Get a list of billing usage by day.",
      "type": "array",
      "items": {
        "description": "Represents the usage for billing purpose in one day",
        "type": "object",
        "properties": {
          "Date": {
            "description": "Represent the date of the usage",
            "type": "string",
            "readOnly": false,
            "x-nullable": false
          },
          "StoredImages": {
            "format": "int32",
            "description": "Gets the peak number of stored images in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          },
          "TrainedImages": {
            "format": "int32",
            "description": "Gets the total number of images used in training in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          },
          "UploadedImages": {
            "format": "int32",
            "description": "Gets the total number of images uploaded to service in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          },
          "QuickTests": {
            "format": "int32",
            "description": "Gets the total number of quicktests in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          },
          "TrainingTimeInMs": {
            "format": "int32",
            "description": "Gets the total training time in milliseconds in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          }
        },
        "x-nullable": false
      },
      "readOnly": false
    }
  }
}
<TrainingUsageModel>
  <Tier>string</Tier>
  <Projects>
    <Total>0</Total>
    <Used>0</Used>
  </Projects>
  <PerProjectQuota>
    <ProjectId>string</ProjectId>
    <Iterations>
      <Total>0</Total>
      <Used>0</Used>
    </Iterations>
    <Images>
      <Total>0</Total>
      <Used>0</Used>
    </Images>
    <Tags>
      <Total>0</Total>
      <Used>0</Used>
    </Tags>
  </PerProjectQuota>
  <DailyUsage>
    <Date>string</Date>
    <StoredImages>0</StoredImages>
    <TrainedImages>0</TrainedImages>
    <UploadedImages>0</UploadedImages>
    <QuickTests>0</QuickTests>
    <TrainingTimeInMs>0</TrainingTimeInMs>
  </DailyUsage>
</TrainingUsageModel>
{
  "description": "Represents a set of quotas assocated with an account.",
  "type": "object",
  "properties": {
    "Tier": {
      "description": "Gets the tier of user.",
      "type": "string",
      "readOnly": false,
      "x-nullable": false
    },
    "Projects": {
      "description": "Gets the project quota.",
      "type": "object",
      "properties": {
        "Total": {
          "format": "int32",
          "description": "The total allowable amount in the quota.",
          "type": "integer",
          "readOnly": false,
          "x-nullable": false
        },
        "Used": {
          "format": "int32",
          "description": "The amount of quota that has currently been used.",
          "type": "integer",
          "readOnly": false,
          "x-nullable": false
        }
      },
      "readOnly": false
    },
    "PerProjectQuota": {
      "description": "Gets a list of quotas that apply per-project for each project.",
      "type": "array",
      "items": {
        "description": "Represents a set of quotas for a given project.",
        "type": "object",
        "properties": {
          "ProjectId": {
            "format": "uuid",
            "description": "Gets the project id of the project this quota applies to.",
            "type": "string",
            "readOnly": false,
            "x-nullable": false
          },
          "Iterations": {
            "description": "Gets the iteration quota for the project.",
            "type": "object",
            "properties": {
              "Total": {
                "format": "int32",
                "description": "The total allowable amount in the quota.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              },
              "Used": {
                "format": "int32",
                "description": "The amount of quota that has currently been used.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              }
            },
            "readOnly": false
          },
          "Images": {
            "description": "Gets the image quota for the project.",
            "type": "object",
            "properties": {
              "Total": {
                "format": "int32",
                "description": "The total allowable amount in the quota.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              },
              "Used": {
                "format": "int32",
                "description": "The amount of quota that has currently been used.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              }
            },
            "readOnly": false
          },
          "Tags": {
            "description": "Gets the tag quota for the project.",
            "type": "object",
            "properties": {
              "Total": {
                "format": "int32",
                "description": "The total allowable amount in the quota.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              },
              "Used": {
                "format": "int32",
                "description": "The amount of quota that has currently been used.",
                "type": "integer",
                "readOnly": false,
                "x-nullable": false
              }
            },
            "readOnly": false
          }
        },
        "x-nullable": false
      },
      "readOnly": false
    },
    "DailyUsage": {
      "description": "Get a list of billing usage by day.",
      "type": "array",
      "items": {
        "description": "Represents the usage for billing purpose in one day",
        "type": "object",
        "properties": {
          "Date": {
            "description": "Represent the date of the usage",
            "type": "string",
            "readOnly": false,
            "x-nullable": false
          },
          "StoredImages": {
            "format": "int32",
            "description": "Gets the peak number of stored images in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          },
          "TrainedImages": {
            "format": "int32",
            "description": "Gets the total number of images used in training in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          },
          "UploadedImages": {
            "format": "int32",
            "description": "Gets the total number of images uploaded to service in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          },
          "QuickTests": {
            "format": "int32",
            "description": "Gets the total number of quicktests in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          },
          "TrainingTimeInMs": {
            "format": "int32",
            "description": "Gets the total training time in milliseconds in the day",
            "type": "integer",
            "readOnly": false,
            "x-nullable": false
          }
        },
        "x-nullable": false
      },
      "readOnly": false
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Admin/usage/training/user/{oid}"
-H "Admin-Key: "
-H "Admin-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("Admin-Key", "");
            client.DefaultRequestHeaders.Add("Admin-key", "{subscription key}");

            var uri = "https://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Admin/usage/training/user/{oid}?" + 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://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Admin/usage/training/user/{oid}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Admin-Key", "");
            request.setHeader("Admin-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://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Admin/usage/training/user/{oid}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Admin-Key","");
                xhrObj.setRequestHeader("Admin-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://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Admin/usage/training/user/{oid}";
    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:@"" forHTTPHeaderField:@"Admin-Key"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Admin-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://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Admin/usage/training/user/{oid}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Admin-Key' => '',
    'Admin-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
    'Admin-Key': '',
    'Admin-key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('uaenorth.api.cognitive.microsoft.com')
    conn.request("GET", "/customvision/v1.1/Admin/usage/training/user/{oid}?%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
    'Admin-Key': '',
    'Admin-key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('uaenorth.api.cognitive.microsoft.com')
    conn.request("GET", "/customvision/v1.1/Admin/usage/training/user/{oid}?%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://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Admin/usage/training/user/{oid}')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Admin-Key'] = ''
# Request headers
request['Admin-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