| POST,OPTIONS | /v1/dashboard/finance |
|---|
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 DashboardStatTile() =
member val Key:String = null with get,set
member val Label:String = null with get,set
member val Value:Double = new Double() with get,set
member val PreviousValue:Nullable<Double> = new Nullable<Double>() with get,set
member val Unit:String = null with get,set
member val DeltaPct:Nullable<Double> = new Nullable<Double>() with get,set
[<AllowNullLiteral>]
type DashboardSeriesPoint() =
member val Label:String = null with get,set
member val Value:Double = new Double() with get,set
[<AllowNullLiteral>]
type DashboardSeries() =
member val Name:String = null with get,set
member val Points:ResizeArray<DashboardSeriesPoint> = new ResizeArray<DashboardSeriesPoint>() with get,set
[<AllowNullLiteral>]
type FinanceLocationRow() =
member val LocationName:String = null with get,set
member val ServiceRev:Double = new Double() with get,set
member val ProductRev:Double = new Double() with get,set
member val SubscriptionRev:Double = new Double() with get,set
member val Total:Double = new Double() with get,set
[<AllowNullLiteral>]
type FinanceTopRow() =
member val Name:String = null with get,set
member val Revenue:Double = new Double() with get,set
[<AllowNullLiteral>]
type FinanceSubscriptionInfo() =
member val Mrr:Double = new Double() with get,set
member val Arr:Double = new Double() with get,set
member val ActiveCount:Int32 = new Int32() with get,set
member val NewCount:Int32 = new Int32() with get,set
member val ChurnedCount:Int32 = new Int32() with get,set
member val ChurnRatePct:Double = new Double() with get,set
[<AllowNullLiteral>]
type FinanceResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val Stats:ResizeArray<DashboardStatTile> = new ResizeArray<DashboardStatTile>() with get,set
member val Trend:ResizeArray<DashboardSeries> = new ResizeArray<DashboardSeries>() with get,set
member val SourceMix:DashboardSeries = null with get,set
member val ByLocation:ResizeArray<FinanceLocationRow> = new ResizeArray<FinanceLocationRow>() with get,set
member val TopServices:ResizeArray<FinanceTopRow> = new ResizeArray<FinanceTopRow>() with get,set
member val TopProducts:ResizeArray<FinanceTopRow> = new ResizeArray<FinanceTopRow>() with get,set
member val Subscriptions:FinanceSubscriptionInfo = null with get,set
[<AllowNullLiteral>]
type FinanceRequest() =
member val FromDate:DateTime = new DateTime() with get,set
member val ToDate:DateTime = new DateTime() with get,set
member val LocationIds:ResizeArray<Guid> = new ResizeArray<Guid>() with 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.
POST /v1/dashboard/finance HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FromDate: 0001-01-01,
ToDate: 0001-01-01,
LocationIds:
[
00000000000000000000000000000000
]
}
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
}
},
Stats:
[
{
Key: String,
Label: String,
Value: 0,
PreviousValue: 0,
Unit: String
}
],
Trend:
[
{
Name: String,
Points:
[
{
Label: String,
Value: 0
}
]
}
],
SourceMix:
{
Name: String,
Points:
[
{
Label: String,
Value: 0
}
]
},
ByLocation:
[
{
LocationName: String,
ServiceRev: 0,
ProductRev: 0,
SubscriptionRev: 0,
Total: 0
}
],
TopServices:
[
{
Name: String,
Revenue: 0
}
],
TopProducts:
[
{
Name: String,
Revenue: 0
}
],
Subscriptions:
{
Mrr: 0,
Arr: 0,
ActiveCount: 0,
NewCount: 0,
ChurnedCount: 0,
ChurnRatePct: 0
}
}