POST NewDashboard/DashboardData

Request Information

URI Parameters

None.

Body Parameters

IConnect.ReportingApi.Core.NewDashboardRequest
NameDescriptionTypeAdditional information
AllEmploee

boolean

None.
IndicatorIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "AllEmploee": true,
  "IndicatorIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample: 
<NewDashboardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.ReportingApi.Core">
  <AllEmploee>true</AllEmploee>
  <IndicatorIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </IndicatorIds>
</NewDashboardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IConnect.Domain.Dashboard.NewDashboardViewModel
NameDescriptionTypeAdditional information
Indicators

Collection of IConnect.Core.Data.DashboardIndicatorView

None.
CardOption

Collection of IConnect.Domain.Dashboard.DashboardCardOptionViewModel

None.
DailySalesOverview

decimal number

None.
HourlySalesOverview

decimal number

None.
HeatMap

decimal number

None.
AverageSalesTransaction

decimal number

None.
TotalTransactionToday

decimal number

None.
NewCustomersToday

decimal number

None.
NewAppointmentsToday

decimal number

None.
OutstandingBalance

decimal number

None.
ProjectedLaborForThisWeek

decimal number

None.
ProjectedMembershipRevenueThisMonth

decimal number

None.
ProjectedRevenueFromBookings

decimal number

None.
TotalScheduledHoursForToday

decimal number

None.
TotalBooked

decimal number

None.
Top5discounts

string

None.
Top5categoriesBySales

string

None.
Top5SellingProducts

string

None.
YearlyCompSales

decimal number

None.
MonthlyCompSales

decimal number

None.
WeeklycompSales

decimal number

None.
SalesByPaymentMethod

decimal number

None.
Avg_WalkinServiceTime

decimal number

None.
ClockedInEmployee

decimal number

None.
CommissionEarned

decimal number

None.
InventoryValue

decimal number

None.
OpenPurchaseOrderValue

decimal number

None.
TotalItemOnOpenPurchaseOrder

decimal number

None.
NumberOfActiveCampaign

decimal number

None.
MostRedeemedCampaign

decimal number

None.
CampaignRevenue

decimal number

None.
ProjectedSalesForToday

decimal number

None.
Top5locations

decimal number

None.
Top5salesperson

decimal number

None.
AverageFoodPreparationTime

decimal number

None.
NetSales

decimal number

None.

Response Formats

application/json, text/json

Sample: 
{
  "Indicators": [
    {
      "Id": 1,
      "IndicatorType": 1,
      "Header": "sample string 2",
      "KoValueName": "sample string 3",
      "Footer": "sample string 4",
      "AdditionalParameters": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "Id": 1,
      "IndicatorType": 1,
      "Header": "sample string 2",
      "KoValueName": "sample string 3",
      "Footer": "sample string 4",
      "AdditionalParameters": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "CardOption": [
    {
      "Id": 1,
      "Header": "sample string 2",
      "Visible": true
    },
    {
      "Id": 1,
      "Header": "sample string 2",
      "Visible": true
    }
  ],
  "DailySalesOverview": 1.0,
  "HourlySalesOverview": 1.0,
  "HeatMap": 1.0,
  "AverageSalesTransaction": 1.0,
  "TotalTransactionToday": 1.0,
  "NewCustomersToday": 1.0,
  "NewAppointmentsToday": 1.0,
  "OutstandingBalance": 1.0,
  "ProjectedLaborForThisWeek": 1.0,
  "ProjectedMembershipRevenueThisMonth": 1.0,
  "ProjectedRevenueFromBookings": 1.0,
  "TotalScheduledHoursForToday": 1.0,
  "TotalBooked": 1.0,
  "Top5discounts": "sample string 1",
  "Top5categoriesBySales": "sample string 2",
  "Top5SellingProducts": "sample string 3",
  "YearlyCompSales": 1.0,
  "MonthlyCompSales": 1.0,
  "WeeklycompSales": 1.0,
  "SalesByPaymentMethod": 1.0,
  "Avg_WalkinServiceTime": 1.0,
  "ClockedInEmployee": 1.0,
  "CommissionEarned": 1.0,
  "InventoryValue": 1.0,
  "OpenPurchaseOrderValue": 1.0,
  "TotalItemOnOpenPurchaseOrder": 1.0,
  "NumberOfActiveCampaign": 1.0,
  "MostRedeemedCampaign": 1.0,
  "CampaignRevenue": 1.0,
  "ProjectedSalesForToday": 1.0,
  "Top5locations": 1.0,
  "Top5salesperson": 1.0,
  "AverageFoodPreparationTime": 1.0,
  "NetSales": 1.0
}

application/xml, text/xml

Sample: 
<NewDashboardViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Dashboard">
  <AverageFoodPreparationTime>1</AverageFoodPreparationTime>
  <AverageSalesTransaction>1</AverageSalesTransaction>
  <Avg_WalkinServiceTime>1</Avg_WalkinServiceTime>
  <CampaignRevenue>1</CampaignRevenue>
  <CardOption>
    <DashboardCardOptionViewModel>
      <Header>sample string 2</Header>
      <Id>1</Id>
      <Visible>true</Visible>
    </DashboardCardOptionViewModel>
    <DashboardCardOptionViewModel>
      <Header>sample string 2</Header>
      <Id>1</Id>
      <Visible>true</Visible>
    </DashboardCardOptionViewModel>
  </CardOption>
  <ClockedInEmployee>1</ClockedInEmployee>
  <CommissionEarned>1</CommissionEarned>
  <DailySalesOverview>1</DailySalesOverview>
  <HeatMap>1</HeatMap>
  <HourlySalesOverview>1</HourlySalesOverview>
  <Indicators xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Core.Data">
    <d2p1:DashboardIndicatorView>
      <d2p1:AdditionalParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:AdditionalParameters>
      <d2p1:Footer>sample string 4</d2p1:Footer>
      <d2p1:Header>sample string 2</d2p1:Header>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IndicatorType>TemplateIndicator_1</d2p1:IndicatorType>
      <d2p1:KoValueName>sample string 3</d2p1:KoValueName>
    </d2p1:DashboardIndicatorView>
    <d2p1:DashboardIndicatorView>
      <d2p1:AdditionalParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:AdditionalParameters>
      <d2p1:Footer>sample string 4</d2p1:Footer>
      <d2p1:Header>sample string 2</d2p1:Header>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IndicatorType>TemplateIndicator_1</d2p1:IndicatorType>
      <d2p1:KoValueName>sample string 3</d2p1:KoValueName>
    </d2p1:DashboardIndicatorView>
  </Indicators>
  <InventoryValue>1</InventoryValue>
  <MonthlyCompSales>1</MonthlyCompSales>
  <MostRedeemedCampaign>1</MostRedeemedCampaign>
  <NetSales>1</NetSales>
  <NewAppointmentsToday>1</NewAppointmentsToday>
  <NewCustomersToday>1</NewCustomersToday>
  <NumberOfActiveCampaign>1</NumberOfActiveCampaign>
  <OpenPurchaseOrderValue>1</OpenPurchaseOrderValue>
  <OutstandingBalance>1</OutstandingBalance>
  <ProjectedLaborForThisWeek>1</ProjectedLaborForThisWeek>
  <ProjectedMembershipRevenueThisMonth>1</ProjectedMembershipRevenueThisMonth>
  <ProjectedRevenueFromBookings>1</ProjectedRevenueFromBookings>
  <ProjectedSalesForToday>1</ProjectedSalesForToday>
  <SalesByPaymentMethod>1</SalesByPaymentMethod>
  <Top5SellingProducts>sample string 3</Top5SellingProducts>
  <Top5categoriesBySales>sample string 2</Top5categoriesBySales>
  <Top5discounts>sample string 1</Top5discounts>
  <Top5locations>1</Top5locations>
  <Top5salesperson>1</Top5salesperson>
  <TotalBooked>1</TotalBooked>
  <TotalItemOnOpenPurchaseOrder>1</TotalItemOnOpenPurchaseOrder>
  <TotalScheduledHoursForToday>1</TotalScheduledHoursForToday>
  <TotalTransactionToday>1</TotalTransactionToday>
  <WeeklycompSales>1</WeeklycompSales>
  <YearlyCompSales>1</YearlyCompSales>
</NewDashboardViewModel>