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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class ReportMetricComponentDto
            Public Overridable Property Field As String
            Public Overridable Property Agg As String
        End Class

        Public Partial Class ReportMetricDto
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property Unit As String
            Public Overridable Property Status As String
            Public Overridable Property Base As String
            Public Overridable Property Op As String
            Public Overridable Property Components As List(Of ReportMetricComponentDto) = New List(Of ReportMetricComponentDto)
            Public Overridable Property Joins As List(Of String) = New List(Of String)
        End Class

        Public Partial Class ReportMetricsRequest
        End Class

        Public Partial Class ReportMetricsResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Metrics As List(Of ReportMetricDto) = New List(Of ReportMetricDto)
        End Class
    End Namespace
End Namespace

VB.NET 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"]}]}