Trendsic Platform Service

<back to all web services

ReportMetricsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/report/metrics
import Foundation
import ServiceStack

public class ReportMetricsRequest : Codable
{
    required public init(){}
}

public class ReportMetricsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var metrics:[ReportMetricDto] = []

    required public init(){}
}

public class ReportMetricDto : Codable
{
    public var code:String
    public var name:String
    public var Description:String
    public var unit:String
    public var status:String
    public var base:String
    public var op:String
    public var components:[ReportMetricComponentDto] = []
    public var joins:[String] = []

    required public init(){}
}

public class ReportMetricComponentDto : Codable
{
    public var field:String
    public var agg:String

    required public init(){}
}


Swift ReportMetricsRequest 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 /v1/report/metrics HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Metrics":[{"Code":"String","Name":"String","Description":"String","Unit":"String","Status":"String","Base":"String","Op":"String","Components":[{"Field":"String","Agg":"String"}],"Joins":["String"]}]}