| POST,OPTIONS | /v1/dashboard/finance |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardStatTile:
key: Optional[str] = None
label: Optional[str] = None
value: float = 0.0
previous_value: Optional[float] = None
unit: Optional[str] = None
delta_pct: Optional[float] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardSeriesPoint:
label: Optional[str] = None
value: float = 0.0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardSeries:
name: Optional[str] = None
points: List[DashboardSeriesPoint] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceLocationRow:
location_name: Optional[str] = None
service_rev: float = 0.0
product_rev: float = 0.0
subscription_rev: float = 0.0
total: float = 0.0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceTopRow:
name: Optional[str] = None
revenue: float = 0.0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceSubscriptionInfo:
mrr: float = 0.0
arr: float = 0.0
active_count: int = 0
new_count: int = 0
churned_count: int = 0
churn_rate_pct: float = 0.0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceResponse:
response_status: Optional[ResponseStatus] = None
stats: List[DashboardStatTile] = field(default_factory=list)
trend: List[DashboardSeries] = field(default_factory=list)
source_mix: Optional[DashboardSeries] = None
by_location: List[FinanceLocationRow] = field(default_factory=list)
top_services: List[FinanceTopRow] = field(default_factory=list)
top_products: List[FinanceTopRow] = field(default_factory=list)
subscriptions: Optional[FinanceSubscriptionInfo] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceRequest:
from_date: datetime.datetime = datetime.datetime(1, 1, 1)
to_date: datetime.datetime = datetime.datetime(1, 1, 1)
location_ids: List[str] = field(default_factory=list)
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
}
}