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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ReportMetricsRequest
    {
        
    }

    public static class ReportMetricsResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<ReportMetricDto> Metrics = new ArrayList<ReportMetricDto>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ReportMetricsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<ReportMetricDto> getMetrics() { return Metrics; }
        public ReportMetricsResponse setMetrics(ArrayList<ReportMetricDto> value) { this.Metrics = value; return this; }
    }

    public static class ReportMetricDto
    {
        public String Code = null;
        public String Name = null;
        public String Description = null;
        public String Unit = null;
        public String Status = null;
        public String Base = null;
        public String Op = null;
        public ArrayList<ReportMetricComponentDto> Components = new ArrayList<ReportMetricComponentDto>();
        public ArrayList<String> Joins = new ArrayList<String>();
        
        public String getCode() { return Code; }
        public ReportMetricDto setCode(String value) { this.Code = value; return this; }
        public String getName() { return Name; }
        public ReportMetricDto setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public ReportMetricDto setDescription(String value) { this.Description = value; return this; }
        public String getUnit() { return Unit; }
        public ReportMetricDto setUnit(String value) { this.Unit = value; return this; }
        public String getStatus() { return Status; }
        public ReportMetricDto setStatus(String value) { this.Status = value; return this; }
        public String getBase() { return Base; }
        public ReportMetricDto setBase(String value) { this.Base = value; return this; }
        public String getOp() { return Op; }
        public ReportMetricDto setOp(String value) { this.Op = value; return this; }
        public ArrayList<ReportMetricComponentDto> getComponents() { return Components; }
        public ReportMetricDto setComponents(ArrayList<ReportMetricComponentDto> value) { this.Components = value; return this; }
        public ArrayList<String> getJoins() { return Joins; }
        public ReportMetricDto setJoins(ArrayList<String> value) { this.Joins = value; return this; }
    }

    public static class ReportMetricComponentDto
    {
        public String Field = null;
        public String Agg = null;
        
        public String getField() { return Field; }
        public ReportMetricComponentDto setField(String value) { this.Field = value; return this; }
        public String getAgg() { return Agg; }
        public ReportMetricComponentDto setAgg(String value) { this.Agg = value; return this; }
    }

}

Java ReportMetricsRequest DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"]}]}