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 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 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
}

Kotlin KpiV2Request DTOs

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

HTTP + OTHER

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/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}]}],"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}]}