POST Dashboard/KeyBusinessParametersOverview

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Dashboard.DashboardRequest
NameDescriptionTypeAdditional information
EmployeeId

integer

None.
NoOfDays

integer

None.
IncludeTax

boolean

None.
IncludeGiftCardSales

boolean

None.
IsMobile

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "EmployeeId": 1,
  "NoOfDays": 1,
  "IncludeTax": true,
  "IncludeGiftCardSales": true,
  "IsMobile": true
}

application/xml, text/xml

Sample: 
<DashboardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Dashboard">
  <EmployeeId>1</EmployeeId>
  <IncludeGiftCardSales>true</IncludeGiftCardSales>
  <IncludeTax>true</IncludeTax>
  <IsMobile>true</IsMobile>
  <NoOfDays>1</NoOfDays>
</DashboardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IConnect.Domain.Dashboard.KeyParameterViewModel
NameDescriptionTypeAdditional information
KeyParameterConsultantNumberToday

string

None.
KeyParameterConsultantNumberWeek

string

None.
KeyParameterConsultantNumberMonth

string

None.
KeyParameterConsultantNumberYear

string

None.
KeyParameterCaptureRateToday

string

None.
KeyParameterCaptureRateWeek

string

None.
KeyParameterCaptureRateMonth

string

None.
KeyParameterCaptureRateYear

string

None.
KeyParameterConversionToday

string

None.
KeyParameterConversionWeek

string

None.
KeyParameterConversionMonth

string

None.
KeyParameterConversionYear

string

None.
KeyParameterAverageSalePerCustomerToday

string

None.
KeyParameterAverageSalePerCustomerWeek

string

None.
KeyParameterAverageSalePerCustomerMonth

string

None.
KeyParameterAverageSalePerCustomerYear

string

None.
KeyParameterAverageUnitPerCustomerToday

string

None.
KeyParameterAverageUnitPerCustomerWeek

string

None.
KeyParameterAverageUnitPerCustomerMonth

string

None.
KeyParameterAverageUnitPerCustomerYear

string

None.
KeyParameterNewCustomerNumberToday

string

None.
KeyParameterNewCustomerNumberWeek

string

None.
KeyParameterNewCustomerNumberMonth

string

None.
KeyParameterNewCustomerNumberYear

string

None.
KeyParameterCustomerCaptureRateToday

string

None.
KeyParameterCustomerCaptureRateWeek

string

None.
KeyParameterCustomerCaptureRateMonth

string

None.
KeyParameterCustomerCaptureRateYear

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "KeyParameterConsultantNumberToday": "sample string 1",
  "KeyParameterConsultantNumberWeek": "sample string 2",
  "KeyParameterConsultantNumberMonth": "sample string 3",
  "KeyParameterConsultantNumberYear": "sample string 4",
  "KeyParameterCaptureRateToday": "sample string 5",
  "KeyParameterCaptureRateWeek": "sample string 6",
  "KeyParameterCaptureRateMonth": "sample string 7",
  "KeyParameterCaptureRateYear": "sample string 8",
  "KeyParameterConversionToday": "sample string 9",
  "KeyParameterConversionWeek": "sample string 10",
  "KeyParameterConversionMonth": "sample string 11",
  "KeyParameterConversionYear": "sample string 12",
  "KeyParameterAverageSalePerCustomerToday": "sample string 13",
  "KeyParameterAverageSalePerCustomerWeek": "sample string 14",
  "KeyParameterAverageSalePerCustomerMonth": "sample string 15",
  "KeyParameterAverageSalePerCustomerYear": "sample string 16",
  "KeyParameterAverageUnitPerCustomerToday": "sample string 17",
  "KeyParameterAverageUnitPerCustomerWeek": "sample string 18",
  "KeyParameterAverageUnitPerCustomerMonth": "sample string 19",
  "KeyParameterAverageUnitPerCustomerYear": "sample string 20",
  "KeyParameterNewCustomerNumberToday": "sample string 21",
  "KeyParameterNewCustomerNumberWeek": "sample string 22",
  "KeyParameterNewCustomerNumberMonth": "sample string 23",
  "KeyParameterNewCustomerNumberYear": "sample string 24",
  "KeyParameterCustomerCaptureRateToday": "sample string 25",
  "KeyParameterCustomerCaptureRateWeek": "sample string 26",
  "KeyParameterCustomerCaptureRateMonth": "sample string 27",
  "KeyParameterCustomerCaptureRateYear": "sample string 28"
}

application/xml, text/xml

Sample: 
<KeyParameterViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Dashboard">
  <KeyParameterAverageSalePerCustomerMonth>sample string 15</KeyParameterAverageSalePerCustomerMonth>
  <KeyParameterAverageSalePerCustomerToday>sample string 13</KeyParameterAverageSalePerCustomerToday>
  <KeyParameterAverageSalePerCustomerWeek>sample string 14</KeyParameterAverageSalePerCustomerWeek>
  <KeyParameterAverageSalePerCustomerYear>sample string 16</KeyParameterAverageSalePerCustomerYear>
  <KeyParameterAverageUnitPerCustomerMonth>sample string 19</KeyParameterAverageUnitPerCustomerMonth>
  <KeyParameterAverageUnitPerCustomerToday>sample string 17</KeyParameterAverageUnitPerCustomerToday>
  <KeyParameterAverageUnitPerCustomerWeek>sample string 18</KeyParameterAverageUnitPerCustomerWeek>
  <KeyParameterAverageUnitPerCustomerYear>sample string 20</KeyParameterAverageUnitPerCustomerYear>
  <KeyParameterCaptureRateMonth>sample string 7</KeyParameterCaptureRateMonth>
  <KeyParameterCaptureRateToday>sample string 5</KeyParameterCaptureRateToday>
  <KeyParameterCaptureRateWeek>sample string 6</KeyParameterCaptureRateWeek>
  <KeyParameterCaptureRateYear>sample string 8</KeyParameterCaptureRateYear>
  <KeyParameterConsultantNumberMonth>sample string 3</KeyParameterConsultantNumberMonth>
  <KeyParameterConsultantNumberToday>sample string 1</KeyParameterConsultantNumberToday>
  <KeyParameterConsultantNumberWeek>sample string 2</KeyParameterConsultantNumberWeek>
  <KeyParameterConsultantNumberYear>sample string 4</KeyParameterConsultantNumberYear>
  <KeyParameterConversionMonth>sample string 11</KeyParameterConversionMonth>
  <KeyParameterConversionToday>sample string 9</KeyParameterConversionToday>
  <KeyParameterConversionWeek>sample string 10</KeyParameterConversionWeek>
  <KeyParameterConversionYear>sample string 12</KeyParameterConversionYear>
  <KeyParameterCustomerCaptureRateMonth>sample string 27</KeyParameterCustomerCaptureRateMonth>
  <KeyParameterCustomerCaptureRateToday>sample string 25</KeyParameterCustomerCaptureRateToday>
  <KeyParameterCustomerCaptureRateWeek>sample string 26</KeyParameterCustomerCaptureRateWeek>
  <KeyParameterCustomerCaptureRateYear>sample string 28</KeyParameterCustomerCaptureRateYear>
  <KeyParameterNewCustomerNumberMonth>sample string 23</KeyParameterNewCustomerNumberMonth>
  <KeyParameterNewCustomerNumberToday>sample string 21</KeyParameterNewCustomerNumberToday>
  <KeyParameterNewCustomerNumberWeek>sample string 22</KeyParameterNewCustomerNumberWeek>
  <KeyParameterNewCustomerNumberYear>sample string 24</KeyParameterNewCustomerNumberYear>
</KeyParameterViewModel>