GET api/CTXDashboard/GetPerYearPerSite/{SiteURL}

Request Information

URI Parameters

Name	Description	Type	Additional information
SiteURL		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Dashboard

Name	Type	Additional information
intAppid	integer	None.
Month	date	None.
OrderCount	decimal number	None.
GuestCount	decimal number	None.
OrderAmount	decimal number	None.
AvgOrder	decimal number	None.
AvgGuestCheck	decimal number	None.
AvgOrderGuest	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "intAppid": 1,
    "Month": "2025-05-04T18:50:26.4550659-04:00",
    "OrderCount": 3.1,
    "GuestCount": 4.1,
    "OrderAmount": 5.1,
    "AvgOrder": 1.645161,
    "AvgGuestCheck": 1.243902,
    "AvgOrderGuest": 1.322581
  },
  {
    "intAppid": 1,
    "Month": "2025-05-04T18:50:26.4550659-04:00",
    "OrderCount": 3.1,
    "GuestCount": 4.1,
    "OrderAmount": 5.1,
    "AvgOrder": 1.645161,
    "AvgGuestCheck": 1.243902,
    "AvgOrderGuest": 1.322581
  }
]

text/html

Sample:

[{"intAppid":1,"Month":"2025-05-04T18:50:26.4550659-04:00","OrderCount":3.1,"GuestCount":4.1,"OrderAmount":5.1,"AvgOrder":1.645161,"AvgGuestCheck":1.243902,"AvgOrderGuest":1.322581},{"intAppid":1,"Month":"2025-05-04T18:50:26.4550659-04:00","OrderCount":3.1,"GuestCount":4.1,"OrderAmount":5.1,"AvgOrder":1.645161,"AvgGuestCheck":1.243902,"AvgOrderGuest":1.322581}]

application/xml, text/xml

Sample:

<ArrayOfDashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRMAPI.Models">
  <Dashboard>
    <GuestCount>4.1</GuestCount>
    <Month>2025-05-04T18:50:26.4550659-04:00</Month>
    <OrderAmount>5.1</OrderAmount>
    <OrderCount>3.1</OrderCount>
    <intAppid>1</intAppid>
  </Dashboard>
  <Dashboard>
    <GuestCount>4.1</GuestCount>
    <Month>2025-05-04T18:50:26.4550659-04:00</Month>
    <OrderAmount>5.1</OrderAmount>
    <OrderCount>3.1</OrderCount>
    <intAppid>1</intAppid>
  </Dashboard>
</ArrayOfDashboard>