latestSwagger 2.02026-08-10143234301.7 KB

dc2736850e42

Rest

Get's the summary data for the given criteria

get/Dashboard/Summary

Query parameters

requestModel.dateRange.startstring date-time
requestModel.dateRange.endstring date-time
requestModel.locationIdsinteger[]

Location Ids to grab data for

requestModel.accrualboolean

Whether to get data on an accrual basis or cash

requestModel.yearOverYearboolean

Whether to get comparison data year over year or month over month

Headers

Authorizationstring required

Bearer {user_token}

SiteIdinteger required

Site ID

Response

OK

Totalnumber double

The total amount of sales

LastMonthTotalnumber double

The total percent changes in sales

TotalGraphnumber[]

The total plot data

Productsnumber double

The total amount of product sales

LastMonthProductsnumber double

The total percent changes in product sales

ProductsGraphnumber[]

The total plot data

NewContractsinteger

The total amount of new contract sales

LastMonthNewContractsinteger

The total percent changes in new contract sales

NewContractsGraphinteger[]

The total plot data

OnlineBookingsinteger

The total amount of online booking sales

LastMonthOnlineBookingsinteger

The total percent changes in online booking sales

OnlineBookingsGraphinteger[]

The total plot data

Attendanceinteger

The total amount of attendance sales

LastMonthAttendanceinteger

The total percent changes in attendance sales

AttendanceGraphinteger[]

The total plot data

FirstVisitsinteger

The total amount of first visit sales

LastMonthFirstVisitsinteger

The total percent changes in first visit sales

FirstVisitsGraphinteger[]

The total plot data for first visits

ComparisonDateRangeStartstring

The date range start used for comparing summary totals

ComparisonDateRangeEndstring

The date range end used for comparing summary totals