CoreService

<back to all web services

GetStatisticsSummary

Statistics

Gets statistic like Resources by OsTypes, etc.

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/statistics/summaryGets statistics like Resources by OsTypes, etc.
GET/statistics/summaryGets statistics like Resources by OsTypes, etc.
"use strict";
/** @typedef {'SingleDatapoint'|'SingleDataset'|'MultiDataset'} */
export var StatisticsDataType;
(function (StatisticsDataType) {
    StatisticsDataType["SingleDatapoint"] = "SingleDatapoint"
    StatisticsDataType["SingleDataset"] = "SingleDataset"
    StatisticsDataType["MultiDataset"] = "MultiDataset"
})(StatisticsDataType || (StatisticsDataType = {}));
export class StatisticsSummaryDto {
    /** @param {{generatedOn?:string,statistics?:{ [index:string]: IStatisticsData; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    generatedOn;
    /** @type {{ [index:string]: IStatisticsData; }} */
    statistics = {};
}
export class GetStatisticsSummary {
    /** @param {{tenantName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    tenantName;
}

JavaScript GetStatisticsSummary DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/statistics/summary HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"generatedOn":"0001-01-01T00:00:00.0000000Z","statistics":{"String":null}}