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

export class ReportMetricComponentDto
{
    public Field: string;
    public Agg: string;

    public constructor(init?: Partial<ReportMetricComponentDto>) { (Object as any).assign(this, init); }
}

export class ReportMetricDto
{
    public Code: string;
    public Name: string;
    public Description: string;
    public Unit: string;
    public Status: string;
    public Base: string;
    public Op: string;
    public Components: ReportMetricComponentDto[] = [];
    public Joins: string[] = [];

    public constructor(init?: Partial<ReportMetricDto>) { (Object as any).assign(this, init); }
}

export class ReportMetricsResponse
{
    public ResponseStatus: ResponseStatus;
    public Metrics: ReportMetricDto[] = [];

    public constructor(init?: Partial<ReportMetricsResponse>) { (Object as any).assign(this, init); }
}

export class ReportMetricsRequest
{

    public constructor(init?: Partial<ReportMetricsRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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"]}]}