Trendsic Platform Service

<back to all web services

KpiV2Request

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dashboard/kpiv2
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DashboardStatTile() = 
        member val Key:String = null with get,set
        member val Label:String = null with get,set
        member val Value:Double = new Double() with get,set
        member val PreviousValue:Nullable<Double> = new Nullable<Double>() with get,set
        member val Unit:String = null with get,set
        member val DeltaPct:Nullable<Double> = new Nullable<Double>() with get,set

    [<AllowNullLiteral>]
    type DashboardSeriesPoint() = 
        member val Label:String = null with get,set
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type DashboardSeries() = 
        member val Name:String = null with get,set
        member val Points:ResizeArray<DashboardSeriesPoint> = new ResizeArray<DashboardSeriesPoint>() with get,set

    [<AllowNullLiteral>]
    type KpiV2LocationRow() = 
        member val LocationName:String = null with get,set
        member val Walkins:Int32 = new Int32() with get,set
        member val Completed:Int32 = new Int32() with get,set
        member val AvgServiceMinutes:Double = new Double() with get,set
        member val AbandonmentPct:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type KpiV2WorkerRow() = 
        member val WorkerName:String = null with get,set
        member val Completed:Int32 = new Int32() with get,set
        member val AvgServiceMinutes:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type KpiV2HeatPoint() = 
        member val Dow:Int32 = new Int32() with get,set
        member val Hr:Int32 = new Int32() with get,set
        member val Cnt:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type KpiV2LiveRow() = 
        member val LocationName:String = null with get,set
        member val Waiting:Int32 = new Int32() with get,set
        member val InProgress:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type KpiV2Response() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Stats:ResizeArray<DashboardStatTile> = new ResizeArray<DashboardStatTile>() with get,set
        member val Trend:ResizeArray<DashboardSeries> = new ResizeArray<DashboardSeries>() with get,set
        member val ServicesByType:DashboardSeries = null with get,set
        member val LocationLeaderboard:ResizeArray<KpiV2LocationRow> = new ResizeArray<KpiV2LocationRow>() with get,set
        member val WorkerProductivity:ResizeArray<KpiV2WorkerRow> = new ResizeArray<KpiV2WorkerRow>() with get,set
        member val Heatmap:ResizeArray<KpiV2HeatPoint> = new ResizeArray<KpiV2HeatPoint>() with get,set
        member val LiveQueue:ResizeArray<KpiV2LiveRow> = new ResizeArray<KpiV2LiveRow>() with get,set

    [<AllowNullLiteral>]
    type KpiV2Request() = 
        member val FromDate:DateTime = new DateTime() with get,set
        member val ToDate:DateTime = new DateTime() with get,set
        member val LocationIds:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set

F# KpiV2Request DTOs

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