| POST,OPTIONS | /v1/dashboard/kpiv2 |
|---|
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 KpiV2LocationRow:
location_name: Optional[str] = None
walkins: int = 0
completed: int = 0
avg_service_minutes: float = 0.0
abandonment_pct: float = 0.0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KpiV2WorkerRow:
worker_name: Optional[str] = None
completed: int = 0
avg_service_minutes: float = 0.0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KpiV2HeatPoint:
dow: int = 0
hr: int = 0
cnt: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KpiV2LiveRow:
location_name: Optional[str] = None
waiting: int = 0
in_progress: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcNamedTime:
id: Optional[str] = None
name: Optional[str] = None
signed_sec: int = 0
served: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcTint:
field: Optional[str] = None
tone: Optional[str] = None
reason: Optional[str] = None
value: Optional[float] = None
reference: Optional[float] = None
branch_value: Optional[float] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcMetrics:
checkins: int = 0
walkins: int = 0
appts: int = 0
served: int = 0
no_shows: int = 0
appt_no_shows: int = 0
cancelled_at_window: int = 0
abandoned: int = 0
called: int = 0
called_up: int = 0
abandon_rate: Optional[float] = None
no_show_rate: Optional[float] = None
avg_service_sec: Optional[float] = None
median_service_sec: Optional[float] = None
avg_wait_sec: Optional[float] = None
max_wait_sec: int = 0
avg_walk_up_sec: Optional[float] = None
expected_service_sec: Optional[float] = None
signed_sec: int = 0
serving_sec: int = 0
paused_sec: int = 0
idle_sec: int = 0
unstaffed_sec: int = 0
utilization: Optional[float] = None
idle_share: Optional[float] = None
paused_share: Optional[float] = None
sessions: int = 0
open_days: int = 0
fees_earned: Optional[Decimal] = None
avg_fee: Optional[Decimal] = None
fees_per_staffed_hour: Optional[Decimal] = None
expected_fees_per_staffed_hour: Optional[Decimal] = None
labor_cost: Optional[Decimal] = None
labor_partial: bool = False
missing_cost_employee_ids: List[str] = field(default_factory=list)
missing_cost: List[SvcNamedTime] = field(default_factory=list)
labor_locked: bool = False
contribution: Optional[Decimal] = None
lost_fees: Optional[Decimal] = None
lost_no_show_fees: Optional[Decimal] = None
mix: Dict[str, int] = field(default_factory=dict)
hourly_served: List[int] = field(default_factory=list)
hourly_fees: List[Decimal] = field(default_factory=list)
hourly_cost: List[Decimal] = field(default_factory=list)
tints: List[SvcTint] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcBranchRow:
branch_id: Optional[str] = None
name: Optional[str] = None
state_code: Optional[str] = None
zone_code: Optional[str] = None
time_zone: Optional[str] = None
windows: int = 0
recording_since_utc: Optional[datetime.datetime] = None
sessions_since_utc: Optional[datetime.datetime] = None
metrics: Optional[SvcMetrics] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcStateRow:
state_code: Optional[str] = None
state_name: Optional[str] = None
branches: int = 0
metrics: Optional[SvcMetrics] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcComparison:
mode: Optional[str] = None
from_date: Optional[datetime.datetime] = None
to_date: Optional[datetime.datetime] = None
cutoff_minute: Optional[int] = None
has_data: bool = False
metrics: Optional[SvcMetrics] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcFeeChange:
location_id: Optional[str] = None
on_date: datetime.datetime = datetime.datetime(1, 1, 1)
from_fee: Decimal = decimal.Decimal(0)
to_fee: Decimal = decimal.Decimal(0)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcServiceRow:
line_id: Optional[str] = None
name: Optional[str] = None
completed: int = 0
avg_service_sec: Optional[float] = None
branch_avg_service_sec: Optional[float] = None
fees_earned: Optional[Decimal] = None
fee_current: Optional[Decimal] = None
fee_min: Optional[Decimal] = None
fee_max: Optional[Decimal] = None
fee_per_minute: Optional[Decimal] = None
branch_fee_per_minute: Optional[Decimal] = None
fee_changes: List[SvcFeeChange] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcHourRow:
local_hour: int = 0
served: int = 0
fees_earned: Optional[Decimal] = None
cost_to_staff: Optional[Decimal] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcWorkerRow:
employee_id: Optional[str] = None
branch_id: Optional[str] = None
branch_name: Optional[str] = None
name: Optional[str] = None
served: int = 0
avg_service_sec: Optional[float] = None
utilization: Optional[float] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcAlert:
level: Optional[str] = None
view: Optional[str] = None
code: Optional[str] = None
station_id: Optional[str] = None
employee_id: Optional[str] = None
branch_id: Optional[str] = None
line_id: Optional[str] = None
name: Optional[str] = None
other_line_id: Optional[str] = None
other_name: Optional[str] = None
station_ids: List[str] = field(default_factory=list)
values: Dict[str, float] = field(default_factory=dict)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcScope:
state_code: Optional[str] = None
branches: List[SvcBranchRow] = field(default_factory=list)
states: List[SvcStateRow] = field(default_factory=list)
total: Optional[SvcMetrics] = None
comparison: Optional[SvcComparison] = None
fees_by_service: List[SvcServiceRow] = field(default_factory=list)
by_hour: List[SvcHourRow] = field(default_factory=list)
workers: List[SvcWorkerRow] = field(default_factory=list)
multi_zone: bool = False
multi_state: bool = False
recording_since_utc: Optional[datetime.datetime] = None
sessions_since_utc: Optional[datetime.datetime] = None
alerts: List[SvcAlert] = field(default_factory=list)
can_see_staff: bool = False
can_see_financial: bool = False
can_see_pay: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KpiV2Response:
response_status: Optional[ResponseStatus] = None
stats: List[DashboardStatTile] = field(default_factory=list)
trend: List[DashboardSeries] = field(default_factory=list)
services_by_type: Optional[DashboardSeries] = None
location_leaderboard: List[KpiV2LocationRow] = field(default_factory=list)
worker_productivity: List[KpiV2WorkerRow] = field(default_factory=list)
heatmap: List[KpiV2HeatPoint] = field(default_factory=list)
live_queue: List[KpiV2LiveRow] = field(default_factory=list)
scope: Optional[SvcScope] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KpiV2Request:
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)
include_scope: bool = False
state_code: Optional[str] = None
compare: Optional[str] = None
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/kpiv2 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
],
IncludeScope: False,
StateCode: String,
Compare: String
}
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
}
]
}
],
ServicesByType:
{
Name: String,
Points:
[
{
Label: String,
Value: 0
}
]
},
LocationLeaderboard:
[
{
LocationName: String,
Walkins: 0,
Completed: 0,
AvgServiceMinutes: 0,
AbandonmentPct: 0
}
],
WorkerProductivity:
[
{
WorkerName: String,
Completed: 0,
AvgServiceMinutes: 0
}
],
Heatmap:
[
{
Dow: 0,
Hr: 0,
Cnt: 0
}
],
LiveQueue:
[
{
LocationName: String,
Waiting: 0,
InProgress: 0
}
],
Scope:
{
StateCode: String,
Branches:
[
{
BranchId: 00000000000000000000000000000000,
Name: String,
StateCode: String,
ZoneCode: String,
TimeZone: String,
Windows: 0,
RecordingSinceUtc: 0001-01-01,
SessionsSinceUtc: 0001-01-01,
Metrics:
{
Checkins: 0,
Walkins: 0,
Appts: 0,
Served: 0,
NoShows: 0,
ApptNoShows: 0,
CancelledAtWindow: 0,
Abandoned: 0,
Called: 0,
CalledUp: 0,
AbandonRate: 0,
NoShowRate: 0,
AvgServiceSec: 0,
MedianServiceSec: 0,
AvgWaitSec: 0,
MaxWaitSec: 0,
AvgWalkUpSec: 0,
ExpectedServiceSec: 0,
SignedSec: 0,
ServingSec: 0,
PausedSec: 0,
IdleSec: 0,
UnstaffedSec: 0,
Utilization: 0,
IdleShare: 0,
PausedShare: 0,
Sessions: 0,
OpenDays: 0,
FeesEarned: 0,
AvgFee: 0,
FeesPerStaffedHour: 0,
ExpectedFeesPerStaffedHour: 0,
LaborCost: 0,
LaborPartial: False,
MissingCostEmployeeIds:
[
00000000000000000000000000000000
],
MissingCost:
[
{
Id: 00000000000000000000000000000000,
Name: String,
SignedSec: 0,
Served: 0
}
],
LaborLocked: False,
Contribution: 0,
LostFees: 0,
LostNoShowFees: 0,
Mix:
{
00000000000000000000000000000000: 0
},
HourlyServed:
[
0
],
HourlyFees:
[
0
],
HourlyCost:
[
0
],
Tints:
[
{
Field: String,
Tone: String,
Reason: String,
Value: 0,
Reference: 0,
BranchValue: 0
}
]
}
}
],
States:
[
{
StateCode: String,
StateName: String,
Branches: 0,
Metrics:
{
Checkins: 0,
Walkins: 0,
Appts: 0,
Served: 0,
NoShows: 0,
ApptNoShows: 0,
CancelledAtWindow: 0,
Abandoned: 0,
Called: 0,
CalledUp: 0,
AbandonRate: 0,
NoShowRate: 0,
AvgServiceSec: 0,
MedianServiceSec: 0,
AvgWaitSec: 0,
MaxWaitSec: 0,
AvgWalkUpSec: 0,
ExpectedServiceSec: 0,
SignedSec: 0,
ServingSec: 0,
PausedSec: 0,
IdleSec: 0,
UnstaffedSec: 0,
Utilization: 0,
IdleShare: 0,
PausedShare: 0,
Sessions: 0,
OpenDays: 0,
FeesEarned: 0,
AvgFee: 0,
FeesPerStaffedHour: 0,
ExpectedFeesPerStaffedHour: 0,
LaborCost: 0,
LaborPartial: False,
MissingCostEmployeeIds:
[
00000000000000000000000000000000
],
MissingCost:
[
{
Id: 00000000000000000000000000000000,
Name: String,
SignedSec: 0,
Served: 0
}
],
LaborLocked: False,
Contribution: 0,
LostFees: 0,
LostNoShowFees: 0,
Mix:
{
00000000000000000000000000000000: 0
},
HourlyServed:
[
0
],
HourlyFees:
[
0
],
HourlyCost:
[
0
],
Tints:
[
{
Field: String,
Tone: String,
Reason: String,
Value: 0,
Reference: 0,
BranchValue: 0
}
]
}
}
],
Total:
{
Checkins: 0,
Walkins: 0,
Appts: 0,
Served: 0,
NoShows: 0,
ApptNoShows: 0,
CancelledAtWindow: 0,
Abandoned: 0,
Called: 0,
CalledUp: 0,
AbandonRate: 0,
NoShowRate: 0,
AvgServiceSec: 0,
MedianServiceSec: 0,
AvgWaitSec: 0,
MaxWaitSec: 0,
AvgWalkUpSec: 0,
ExpectedServiceSec: 0,
SignedSec: 0,
ServingSec: 0,
PausedSec: 0,
IdleSec: 0,
UnstaffedSec: 0,
Utilization: 0,
IdleShare: 0,
PausedShare: 0,
Sessions: 0,
OpenDays: 0,
FeesEarned: 0,
AvgFee: 0,
FeesPerStaffedHour: 0,
ExpectedFeesPerStaffedHour: 0,
LaborCost: 0,
LaborPartial: False,
MissingCostEmployeeIds:
[
00000000000000000000000000000000
],
MissingCost:
[
{
Id: 00000000000000000000000000000000,
Name: String,
SignedSec: 0,
Served: 0
}
],
LaborLocked: False,
Contribution: 0,
LostFees: 0,
LostNoShowFees: 0,
Mix:
{
00000000000000000000000000000000: 0
},
HourlyServed:
[
0
],
HourlyFees:
[
0
],
HourlyCost:
[
0
],
Tints:
[
{
Field: String,
Tone: String,
Reason: String,
Value: 0,
Reference: 0,
BranchValue: 0
}
]
},
Comparison:
{
Mode: String,
FromDate: 0001-01-01,
ToDate: 0001-01-01,
CutoffMinute: 0,
HasData: False,
Metrics:
{
Checkins: 0,
Walkins: 0,
Appts: 0,
Served: 0,
NoShows: 0,
ApptNoShows: 0,
CancelledAtWindow: 0,
Abandoned: 0,
Called: 0,
CalledUp: 0,
AbandonRate: 0,
NoShowRate: 0,
AvgServiceSec: 0,
MedianServiceSec: 0,
AvgWaitSec: 0,
MaxWaitSec: 0,
AvgWalkUpSec: 0,
ExpectedServiceSec: 0,
SignedSec: 0,
ServingSec: 0,
PausedSec: 0,
IdleSec: 0,
UnstaffedSec: 0,
Utilization: 0,
IdleShare: 0,
PausedShare: 0,
Sessions: 0,
OpenDays: 0,
FeesEarned: 0,
AvgFee: 0,
FeesPerStaffedHour: 0,
ExpectedFeesPerStaffedHour: 0,
LaborCost: 0,
LaborPartial: False,
MissingCostEmployeeIds:
[
00000000000000000000000000000000
],
MissingCost:
[
{
Id: 00000000000000000000000000000000,
Name: String,
SignedSec: 0,
Served: 0
}
],
LaborLocked: False,
Contribution: 0,
LostFees: 0,
LostNoShowFees: 0,
Mix:
{
00000000000000000000000000000000: 0
},
HourlyServed:
[
0
],
HourlyFees:
[
0
],
HourlyCost:
[
0
],
Tints:
[
{
Field: String,
Tone: String,
Reason: String,
Value: 0,
Reference: 0,
BranchValue: 0
}
]
}
},
FeesByService:
[
{
LineId: 00000000000000000000000000000000,
Name: String,
Completed: 0,
AvgServiceSec: 0,
BranchAvgServiceSec: 0,
FeesEarned: 0,
FeeCurrent: 0,
FeeMin: 0,
FeeMax: 0,
FeePerMinute: 0,
BranchFeePerMinute: 0,
FeeChanges:
[
{
LocationId: 00000000000000000000000000000000,
OnDate: 0001-01-01,
FromFee: 0,
ToFee: 0
}
]
}
],
ByHour:
[
{
LocalHour: 0,
Served: 0,
FeesEarned: 0,
CostToStaff: 0
}
],
Workers:
[
{
EmployeeId: 00000000000000000000000000000000,
BranchId: 00000000000000000000000000000000,
BranchName: String,
Name: String,
Served: 0,
AvgServiceSec: 0,
Utilization: 0
}
],
MultiZone: False,
MultiState: False,
RecordingSinceUtc: 0001-01-01,
SessionsSinceUtc: 0001-01-01,
Alerts:
[
{
Level: String,
View: String,
Code: String,
StationId: 00000000000000000000000000000000,
EmployeeId: 00000000000000000000000000000000,
BranchId: 00000000000000000000000000000000,
LineId: 00000000000000000000000000000000,
Name: String,
OtherLineId: 00000000000000000000000000000000,
OtherName: String,
StationIds:
[
00000000000000000000000000000000
],
Values:
{
String: 0
}
}
],
CanSeeStaff: False,
CanSeeFinancial: False,
CanSeePay: False
}
}