| POST,OPTIONS | /v1/dashboard/finance |
|---|
import Foundation
import ServiceStack
public class FinanceRequest : Codable
{
public var fromDate:Date
public var toDate:Date
public var locationIds:[String] = []
required public init(){}
}
public class FinanceResponse : Codable
{
public var responseStatus:ResponseStatus
public var stats:[DashboardStatTile] = []
public var trend:[DashboardSeries] = []
public var sourceMix:DashboardSeries
public var byLocation:[FinanceLocationRow] = []
public var topServices:[FinanceTopRow] = []
public var topProducts:[FinanceTopRow] = []
public var subscriptions:FinanceSubscriptionInfo
required public init(){}
}
public class DashboardStatTile : Codable
{
public var key:String
public var label:String
public var value:Double
public var previousValue:Double?
public var unit:String
public var deltaPct:Double?
required public init(){}
}
public class DashboardSeries : Codable
{
public var name:String
public var points:[DashboardSeriesPoint] = []
required public init(){}
}
public class DashboardSeriesPoint : Codable
{
public var label:String
public var value:Double
required public init(){}
}
public class FinanceLocationRow : Codable
{
public var locationName:String
public var serviceRev:Double
public var productRev:Double
public var subscriptionRev:Double
public var total:Double
required public init(){}
}
public class FinanceTopRow : Codable
{
public var name:String
public var revenue:Double
required public init(){}
}
public class FinanceSubscriptionInfo : Codable
{
public var mrr:Double
public var arr:Double
public var activeCount:Int
public var newCount:Int
public var churnedCount:Int
public var churnRatePct:Double
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","LocationIds":["00000000000000000000000000000000"]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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","DeltaPct":null}],"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}}