Trendsic Platform Service

KpiV2Request

The following routes are available for this service:
POST,OPTIONS	/v1/dashboard/kpiv2

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class KpiV2Request
{
    open var FromDate:Date? = null
    open var ToDate:Date? = null
    open var LocationIds:ArrayList<UUID> = ArrayList<UUID>()
    open var IncludeScope:Boolean? = null
    open var StateCode:String? = null
    open var Compare:String? = null
}

open class KpiV2Response
{
    open var ResponseStatus:ResponseStatus? = null
    open var Stats:ArrayList<DashboardStatTile> = ArrayList<DashboardStatTile>()
    open var Trend:ArrayList<DashboardSeries> = ArrayList<DashboardSeries>()
    open var ServicesByType:DashboardSeries? = null
    open var LocationLeaderboard:ArrayList<KpiV2LocationRow> = ArrayList<KpiV2LocationRow>()
    open var WorkerProductivity:ArrayList<KpiV2WorkerRow> = ArrayList<KpiV2WorkerRow>()
    open var Heatmap:ArrayList<KpiV2HeatPoint> = ArrayList<KpiV2HeatPoint>()
    open var LiveQueue:ArrayList<KpiV2LiveRow> = ArrayList<KpiV2LiveRow>()
    open var Scope:SvcScope? = null
}

open class DashboardStatTile
{
    open var Key:String? = null
    open var Label:String? = null
    open var Value:Double? = null
    open var PreviousValue:Double? = null
    open var Unit:String? = null
    open var DeltaPct:Double? = null
}

open class DashboardSeries
{
    open var Name:String? = null
    open var Points:ArrayList<DashboardSeriesPoint> = ArrayList<DashboardSeriesPoint>()
}

open class DashboardSeriesPoint
{
    open var Label:String? = null
    open var Value:Double? = null
}

open class KpiV2LocationRow
{
    open var LocationName:String? = null
    open var Walkins:Int? = null
    open var Completed:Int? = null
    open var AvgServiceMinutes:Double? = null
    open var AbandonmentPct:Double? = null
}

open class KpiV2WorkerRow
{
    open var WorkerName:String? = null
    open var Completed:Int? = null
    open var AvgServiceMinutes:Double? = null
}

open class KpiV2HeatPoint
{
    open var Dow:Int? = null
    open var Hr:Int? = null
    open var Cnt:Int? = null
}

open class KpiV2LiveRow
{
    open var LocationName:String? = null
    open var Waiting:Int? = null
    open var InProgress:Int? = null
}

open class SvcScope
{
    open var StateCode:String? = null
    open var Branches:ArrayList<SvcBranchRow> = ArrayList<SvcBranchRow>()
    open var States:ArrayList<SvcStateRow> = ArrayList<SvcStateRow>()
    open var Total:SvcMetrics? = null
    open var Comparison:SvcComparison? = null
    open var FeesByService:ArrayList<SvcServiceRow> = ArrayList<SvcServiceRow>()
    open var ByHour:ArrayList<SvcHourRow> = ArrayList<SvcHourRow>()
    open var Workers:ArrayList<SvcWorkerRow> = ArrayList<SvcWorkerRow>()
    open var MultiZone:Boolean? = null
    open var MultiState:Boolean? = null
    open var RecordingSinceUtc:Date? = null
    open var SessionsSinceUtc:Date? = null
    open var Alerts:ArrayList<SvcAlert> = ArrayList<SvcAlert>()
    open var CanSeeStaff:Boolean? = null
    open var CanSeeFinancial:Boolean? = null
    open var CanSeePay:Boolean? = null
}

open class SvcBranchRow
{
    open var BranchId:UUID? = null
    open var Name:String? = null
    open var StateCode:String? = null
    open var ZoneCode:String? = null
    open var TimeZone:String? = null
    open var Windows:Int? = null
    open var RecordingSinceUtc:Date? = null
    open var SessionsSinceUtc:Date? = null
    open var Metrics:SvcMetrics? = null
}

open class SvcMetrics
{
    open var Checkins:Int? = null
    open var Walkins:Int? = null
    open var Appts:Int? = null
    open var Served:Int? = null
    open var NoShows:Int? = null
    open var ApptNoShows:Int? = null
    open var CancelledAtWindow:Int? = null
    open var Abandoned:Int? = null
    open var Called:Int? = null
    open var CalledUp:Int? = null
    open var AbandonRate:Double? = null
    open var NoShowRate:Double? = null
    open var AvgServiceSec:Double? = null
    open var MedianServiceSec:Double? = null
    open var AvgWaitSec:Double? = null
    open var MaxWaitSec:Int? = null
    open var AvgWalkUpSec:Double? = null
    open var ExpectedServiceSec:Double? = null
    open var SignedSec:Long? = null
    open var ServingSec:Long? = null
    open var PausedSec:Long? = null
    open var IdleSec:Long? = null
    open var UnstaffedSec:Long? = null
    open var Utilization:Double? = null
    open var IdleShare:Double? = null
    open var PausedShare:Double? = null
    open var Sessions:Int? = null
    open var OpenDays:Int? = null
    open var FeesEarned:BigDecimal? = null
    open var AvgFee:BigDecimal? = null
    open var FeesPerStaffedHour:BigDecimal? = null
    open var ExpectedFeesPerStaffedHour:BigDecimal? = null
    open var LaborCost:BigDecimal? = null
    open var LaborPartial:Boolean? = null
    open var MissingCostEmployeeIds:ArrayList<UUID> = ArrayList<UUID>()
    open var MissingCost:ArrayList<SvcNamedTime> = ArrayList<SvcNamedTime>()
    open var LaborLocked:Boolean? = null
    open var Contribution:BigDecimal? = null
    open var LostFees:BigDecimal? = null
    open var LostNoShowFees:BigDecimal? = null
    open var Mix:HashMap<UUID,Int> = HashMap<UUID,Int>()
    open var HourlyServed:ArrayList<Int> = ArrayList<Int>()
    open var HourlyFees:ArrayList<BigDecimal> = ArrayList<BigDecimal>()
    open var HourlyCost:ArrayList<BigDecimal> = ArrayList<BigDecimal>()
    open var Tints:ArrayList<SvcTint> = ArrayList<SvcTint>()
}

open class SvcNamedTime
{
    open var Id:UUID? = null
    open var Name:String? = null
    open var SignedSec:Long? = null
    open var Served:Int? = null
}

open class SvcTint
{
    open var Field:String? = null
    open var Tone:String? = null
    open var Reason:String? = null
    open var Value:Double? = null
    open var Reference:Double? = null
    open var BranchValue:Double? = null
}

open class SvcStateRow
{
    open var StateCode:String? = null
    open var StateName:String? = null
    open var Branches:Int? = null
    open var Metrics:SvcMetrics? = null
}

open class SvcComparison
{
    open var Mode:String? = null
    open var FromDate:Date? = null
    open var ToDate:Date? = null
    open var CutoffMinute:Int? = null
    open var HasData:Boolean? = null
    open var Metrics:SvcMetrics? = null
}

open class SvcServiceRow
{
    open var LineId:UUID? = null
    open var Name:String? = null
    open var Completed:Int? = null
    open var AvgServiceSec:Double? = null
    open var BranchAvgServiceSec:Double? = null
    open var FeesEarned:BigDecimal? = null
    open var FeeCurrent:BigDecimal? = null
    open var FeeMin:BigDecimal? = null
    open var FeeMax:BigDecimal? = null
    open var FeePerMinute:BigDecimal? = null
    open var BranchFeePerMinute:BigDecimal? = null
    open var FeeChanges:ArrayList<SvcFeeChange> = ArrayList<SvcFeeChange>()
}

open class SvcFeeChange
{
    open var LocationId:UUID? = null
    open var OnDate:Date? = null
    open var FromFee:BigDecimal? = null
    open var ToFee:BigDecimal? = null
}

open class SvcHourRow
{
    open var LocalHour:Int? = null
    open var Served:Int? = null
    open var FeesEarned:BigDecimal? = null
    open var CostToStaff:BigDecimal? = null
}

open class SvcWorkerRow
{
    open var EmployeeId:UUID? = null
    open var BranchId:UUID? = null
    open var BranchName:String? = null
    open var Name:String? = null
    open var Served:Int? = null
    open var AvgServiceSec:Double? = null
    open var Utilization:Double? = null
}

open class SvcAlert
{
    open var Level:String? = null
    open var View:String? = null
    open var Code:String? = null
    open var StationId:UUID? = null
    open var EmployeeId:UUID? = null
    open var BranchId:UUID? = null
    open var LineId:UUID? = null
    open var Name:String? = null
    open var OtherLineId:UUID? = null
    open var OtherName:String? = null
    open var StationIds:ArrayList<UUID> = ArrayList<UUID>()
    open var Values:HashMap<String,Double> = HashMap<String,Double>()
}

Kotlin KpiV2Request DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","LocationIds":["00000000000000000000000000000000"],"IncludeScope":false,"StateCode":"String","Compare":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
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}]}],"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-01T00:00:00.0000000","SessionsSinceUtc":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000","SessionsSinceUtc":"0001-01-01T00:00:00.0000000","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}}