Trendsic Platform Service

<back to all web services

FinanceRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dashboard/finance
FinanceRequest Parameters:
NameParameterData TypeRequiredDescription
FromDatebodyDateTimeNo
ToDatebodyDateTimeNo
LocationIdsbodyList<Guid>No
FinanceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
StatsformList<DashboardStatTile>No
TrendformList<DashboardSeries>No
SourceMixformDashboardSeriesNo
ByLocationformList<FinanceLocationRow>No
TopServicesformList<FinanceTopRow>No
TopProductsformList<FinanceTopRow>No
SubscriptionsformFinanceSubscriptionInfoNo
DashboardStatTile Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
LabelformstringNo
ValueformdoubleNo
PreviousValueformdouble?No
UnitformstringNo
DeltaPctformdouble?No
DashboardSeries Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
PointsformList<DashboardSeriesPoint>No
DashboardSeriesPoint Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
ValueformdoubleNo
FinanceLocationRow Parameters:
NameParameterData TypeRequiredDescription
LocationNameformstringNo
ServiceRevformdoubleNo
ProductRevformdoubleNo
SubscriptionRevformdoubleNo
TotalformdoubleNo
FinanceTopRow Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
RevenueformdoubleNo
FinanceSubscriptionInfo Parameters:
NameParameterData TypeRequiredDescription
MrrformdoubleNo
ArrformdoubleNo
ActiveCountformintNo
NewCountformintNo
ChurnedCountformintNo
ChurnRatePctformdoubleNo

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.

POST /v1/dashboard/finance HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
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/csv
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}}