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
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 .xml suffix or ?format=xml

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReportMetricsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Metrics>
    <ReportMetricDto>
      <Base>String</Base>
      <Code>String</Code>
      <Components>
        <ReportMetricComponentDto>
          <Agg>String</Agg>
          <Field>String</Field>
        </ReportMetricComponentDto>
      </Components>
      <Description>String</Description>
      <Joins xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Joins>
      <Name>String</Name>
      <Op>String</Op>
      <Status>String</Status>
      <Unit>String</Unit>
    </ReportMetricDto>
  </Metrics>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ReportMetricsResponse>