Trendsic Platform Service

<back to all web services

KpiV2Request

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class DashboardSeries
    {
        public virtual string Name { get; set; }
        public virtual List<DashboardSeriesPoint> Points { get; set; } = [];
    }

    public partial class DashboardSeriesPoint
    {
        public virtual string Label { get; set; }
        public virtual double Value { get; set; }
    }

    public partial class DashboardStatTile
    {
        public virtual string Key { get; set; }
        public virtual string Label { get; set; }
        public virtual double Value { get; set; }
        public virtual double? PreviousValue { get; set; }
        public virtual string Unit { get; set; }
        public virtual double? DeltaPct { get; set; }
    }

    public partial class KpiV2HeatPoint
    {
        public virtual int Dow { get; set; }
        public virtual int Hr { get; set; }
        public virtual int Cnt { get; set; }
    }

    public partial class KpiV2LiveRow
    {
        public virtual string LocationName { get; set; }
        public virtual int Waiting { get; set; }
        public virtual int InProgress { get; set; }
    }

    public partial class KpiV2LocationRow
    {
        public virtual string LocationName { get; set; }
        public virtual int Walkins { get; set; }
        public virtual int Completed { get; set; }
        public virtual double AvgServiceMinutes { get; set; }
        public virtual double AbandonmentPct { get; set; }
    }

    public partial class KpiV2Request
    {
        public virtual DateTime FromDate { get; set; }
        public virtual DateTime ToDate { get; set; }
        public virtual List<Guid> LocationIds { get; set; } = [];
    }

    public partial class KpiV2Response
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<DashboardStatTile> Stats { get; set; } = [];
        public virtual List<DashboardSeries> Trend { get; set; } = [];
        public virtual DashboardSeries ServicesByType { get; set; }
        public virtual List<KpiV2LocationRow> LocationLeaderboard { get; set; } = [];
        public virtual List<KpiV2WorkerRow> WorkerProductivity { get; set; } = [];
        public virtual List<KpiV2HeatPoint> Heatmap { get; set; } = [];
        public virtual List<KpiV2LiveRow> LiveQueue { get; set; } = [];
    }

    public partial class KpiV2WorkerRow
    {
        public virtual string WorkerName { get; set; }
        public virtual int Completed { get; set; }
        public virtual double AvgServiceMinutes { get; set; }
    }

}

C# KpiV2Request DTOs

POST /v1/dashboard/kpiv2 HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<KpiV2Request xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FromDate>0001-01-01T00:00:00</FromDate>
  <LocationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </LocationIds>
  <ToDate>0001-01-01T00:00:00</ToDate>
</KpiV2Request>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<KpiV2Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Heatmap>
    <KpiV2HeatPoint>
      <Cnt>0</Cnt>
      <Dow>0</Dow>
      <Hr>0</Hr>
    </KpiV2HeatPoint>
  </Heatmap>
  <LiveQueue>
    <KpiV2LiveRow>
      <InProgress>0</InProgress>
      <LocationName>String</LocationName>
      <Waiting>0</Waiting>
    </KpiV2LiveRow>
  </LiveQueue>
  <LocationLeaderboard>
    <KpiV2LocationRow>
      <AbandonmentPct>0</AbandonmentPct>
      <AvgServiceMinutes>0</AvgServiceMinutes>
      <Completed>0</Completed>
      <LocationName>String</LocationName>
      <Walkins>0</Walkins>
    </KpiV2LocationRow>
  </LocationLeaderboard>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <ServicesByType>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </ServicesByType>
  <Stats>
    <DashboardStatTile>
      <Key>String</Key>
      <Label>String</Label>
      <PreviousValue>0</PreviousValue>
      <Unit>String</Unit>
      <Value>0</Value>
    </DashboardStatTile>
  </Stats>
  <Trend>
    <DashboardSeries>
      <Name>String</Name>
      <Points>
        <DashboardSeriesPoint>
          <Label>String</Label>
          <Value>0</Value>
        </DashboardSeriesPoint>
      </Points>
    </DashboardSeries>
  </Trend>
  <WorkerProductivity>
    <KpiV2WorkerRow>
      <AvgServiceMinutes>0</AvgServiceMinutes>
      <Completed>0</Completed>
      <WorkerName>String</WorkerName>
    </KpiV2WorkerRow>
  </WorkerProductivity>
</KpiV2Response>