GET api/Stats/HomeKpi?customerId={customerId}&businessId={businessId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerId

integer

Required

businessId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of KpiResult
NameDescriptionTypeAdditional information
KpiType

KpiType

None.

Label

string

None.

Value

string

None.

Period

KpiResultPeriod

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "KpiType": 1,
    "Label": "sample string 1",
    "Value": "sample string 2",
    "Period": 1
  },
  {
    "KpiType": 1,
    "Label": "sample string 1",
    "Value": "sample string 2",
    "Period": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfKpiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/myReportysModels">
  <KpiResult>
    <KpiType>HoursNumber</KpiType>
    <Label>sample string 1</Label>
    <Period>CurrentWeek</Period>
    <Value>sample string 2</Value>
  </KpiResult>
  <KpiResult>
    <KpiType>HoursNumber</KpiType>
    <Label>sample string 1</Label>
    <Period>CurrentWeek</Period>
    <Value>sample string 2</Value>
  </KpiResult>
</ArrayOfKpiResult>