| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/report/metrics |
|---|
"use strict";
export class ReportMetricComponentDto {
/** @param {{Field?:string,Agg?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Field;
/** @type {string} */
Agg;
}
export class ReportMetricDto {
/** @param {{Code?:string,Name?:string,Description?:string,Unit?:string,Status?:string,Base?:string,Op?:string,Components?:ReportMetricComponentDto[],Joins?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Code;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {string} */
Unit;
/** @type {string} */
Status;
/** @type {string} */
Base;
/** @type {string} */
Op;
/** @type {ReportMetricComponentDto[]} */
Components = [];
/** @type {string[]} */
Joins = [];
}
export class ReportMetricsResponse {
/** @param {{ResponseStatus?:ResponseStatus,Metrics?:ReportMetricDto[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {ReportMetricDto[]} */
Metrics = [];
}
export class ReportMetricsRequest {
constructor(init) { Object.assign(this, init) }
}
JavaScript ReportMetricsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
]
}
]
}