| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/report/metrics |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;
namespace CRM.AgencyPlatform.API.Internal
{
public partial class ReportMetricComponentDto
{
public virtual string Field { get; set; }
public virtual string Agg { get; set; }
}
public partial class ReportMetricDto
{
public virtual string Code { get; set; }
public virtual string Name { get; set; }
public virtual string Description { get; set; }
public virtual string Unit { get; set; }
public virtual string Status { get; set; }
public virtual string Base { get; set; }
public virtual string Op { get; set; }
public virtual List<ReportMetricComponentDto> Components { get; set; } = [];
public virtual List<string> Joins { get; set; } = [];
}
public partial class ReportMetricsRequest
{
}
public partial class ReportMetricsResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual List<ReportMetricDto> Metrics { get; set; } = [];
}
}
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
]
}
]
}