| Required role: | TenantReader |
| GET | /api/statistics/summary | Gets statistics like Resources by OsTypes, etc. | |
|---|---|---|---|
| GET | /statistics/summary | Gets statistics like Resources by OsTypes, etc. |
import Foundation
import ServiceStack
/**
* Gets statistic like Resources by OsTypes, etc.
*/
// @Api(Description="Gets statistic like Resources by OsTypes, etc.")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(StatisticsSummaryDto), StatusCode=200)
public class GetStatisticsSummary : IBaseRequest, IHasTenantName, IGet, Codable
{
// @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
// @Validate(Validator="NotEmpty")
public var tenantName:String
required public init(){}
}
public class StatisticsSummaryDto : Codable
{
public var generatedOn:Date
public var statistics:[String:IStatisticsData] = [:]
required public init(){}
}
public protocol IStatisticsData
{
var name:String { get set }
var type:StatisticsDataType { get set }
}
public enum StatisticsDataType : String, Codable
{
case SingleDatapoint
case SingleDataset
case MultiDataset
}
Swift 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
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}}