Trendsic Platform Service

ReportMetricsRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/report/metrics

namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ReportMetricComponentDto() = 
        member val Field:String = null with get,set
        member val Agg:String = null with get,set

    [<AllowNullLiteral>]
    type ReportMetricDto() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val Unit:String = null with get,set
        member val Status:String = null with get,set
        member val Base:String = null with get,set
        member val Op:String = null with get,set
        member val Components:ResizeArray<ReportMetricComponentDto> = new ResizeArray<ReportMetricComponentDto>() with get,set
        member val Joins:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type ReportMetricsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Metrics:ResizeArray<ReportMetricDto> = new ResizeArray<ReportMetricDto>() with get,set

    [<AllowNullLiteral>]
    type ReportMetricsRequest() = 
        class end

F# 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"]}]}