Statistics: get

Get Managemenet Statistics.

Request - POST https://api-uat.vtopenview.com/statistics

You will need to supply a request body with this method.
You will need to include your access token upon making a request. For more information, see the authentication and authorization page.

Example request with authorization:

curl -- POST Base URI: https://api-uat.vtopenview.com/statistics --header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"

Request Body

Example request body:

Content-Type: application/json { "statistics_request": { "lettings": boolean, "currPeriodStartDate": "date", "currPeriodEndDate": "date", "prevPeriodStartDate": "date", "prevPeriodEndDate": "date", "branchIds": [ { "branchIds": long, } ], "negotiatorIds": [ { "negotiatorId": long, } ] } }

Response

If successful, this method returns a response body with the following structure:

Example response:

HTTPS 200 OK Content-Type: application/json { "Overview": [ { "managedPrevPeriod": decimal, "managedCurrPeriod": decimal, "rentCollectPrevPeriod": decimal, "letOnlyPrevPeriod": decimal, "letOnlyCurrPeriod": decimal, "liveTenanciesPrevPeriod": decimal, "liveTenanciesCurrPeriod": decimal, "prebookedTenantsPrevPeriod": decimal, "prebookedTenantsCurrPeriod": decimal, "advertisedPropsPrevPeriod": decimal, "advertisedPropsCurrPeriod": decimal, } ], "rentalFigures": [ { "mnagedPrevPeriod": decimal, "managedCurrPeriod": decimal, "rentCollectPrevPeriod": decimal, "rentCollectCurrPeriod": decimal, "letOnlyPrevPeriod": decimal, "letOnlyCurrPeriod": decimal, "overallPrevPeriod": decimal, "overallCurrPeriod": decimal, } ], "rentalFiguresPrebooked": [ { "managedPrevPeriod": decimal, "managedCurrPeriod": decimal, "rentCollectPrevPeriod": decimal, "rentCollectCurrPeriod": decimal, "letOnlyPrevPeriod": decimal, "letOnlyCurrPeriod": decimal, "overallPrevPeriod": decimal, "overallCurrPeriod": decimal, } ], "feesValue": [ { "managedPrevPeriod": decimal, "managedCurrPeriod": decimal, "rentCollectPrevPeriod": decimal, "rentCollectCurrPeriod": decimal, } ], "feesPercentage": [ { "managedPrevPeriod": decimal, "managedCurrPeriod": decimal, "rentCollectPrevPeriod": decimal, "rentCollectCurrPeriod": decimal, } ], "advertisedProperties": [ { "propertyVacanciesPrevPeriod": decimal, "propertyVacanciesCurrPeriod": decimal, "lostManagementFeesPrevPeriod": decimal, "lostManagementFeesCurrPeriod": decimal, } ], "Viewings": [ { "viewingsCompletePrevPeriod": decimal, "viewingsCompleteCurrPeriod": decimal, "feedbackReceivedPrevPeriod": decimal, "feedbackReceivedCurrPeriod": decimal, "viewingsBookedPrevPeriod": decimal, "viewingsBookedCurrPeriod": decimal, } ], "totalArrears": [ { "totalArrearsPrev": decimal, "totalArrearsCurr": decimal, } ], "records": [ { "appraisalsPrevPeriod": decimal, "appraisalsCurrPeriod": decimal, "instructionsPrevPeriod": decimal, "instructionsCurrPeriod": decimal, "applicantsPrevPeriod": decimal, "applicantsCurrPeriod": decimal, "viewingsPrevPeriod": decimal, "viewingsCurrPeriod": decimal, "offersPrevPeriod": decimal, "offersCurrPeriod": decimal, } ], "grossSales": [ { "previousPeriod": decimal, "appraisalsCurrPeriod": decimal, "instructionsPrevPeriod": decimal, "instructionsCurrPeriod": decimal, "applicantsPrevPeriod": decimal, "applicantsCurrPeriod": decimal, "viewingsPrevPeriod": decimal, "viewingsCurrPeriod": decimal, "offersPrevPeriod": decimal, "offersCurrPeriod": decimal, } ], "fallenThroughSales": [ { "previousPeriod": decimal, "currentPeriod": decimal, "feesPrevPeriod": decimal, "feesCurrPeriod": decimal, "capitalPrevPeriod": decimal, "capitalCurrPeriod": decimal, } ], "netSales": [ { "previousPeriod": decimal, "currentPeriod": decimal, "feesPrevPeriod": decimal, "feesCurrPeriod": decimal, "capitalPrevPeriod": decimal, "capitalCurrPeriod": decimal, } ], "Instructions": [ { "pipelineFees": decimal, "pipelineUnits": decimal, "feesPrevPeriod": decimal, "feesCurrPeriod": decimal, "capitalPrevPeriod": decimal, "capitalCurrPeriod": decimal, } ], "exchanged": [ { "pipelineFees": decimal, "pipelineUnits": decimal, "feesPrevPeriod": decimal, "feesCurrPeriod": decimal, "capitalPrevPeriod": decimal, "capitalCurrPeriod": decimal, } ], "avHousePrice": [ { "currentPeriod": decimal, "previousPeriod": decimal, "monthPrev12": decimal, "monthPrev11": decimal, "monthPrev10": decimal, "monthPrev9": decimal, "monthPrev8": decimal, "monthPrev7": decimal, "monthPrev6": decimal, "monthPrev5": decimal, "monthPrev4": decimal, "monthPrev3": decimal, "monthPrev2": decimal, "monthPrev1": decimal, } ], "avExchHousePrice": [ { "currentPeriod": decimal, "previousPeriod": decimal, "monthPrev12": decimal, "monthPrev11": decimal, "monthPrev10": decimal, "monthPrev9": decimal, "monthPrev8": decimal, "monthPrev7": decimal, "monthPrev6": decimal, "monthPrev5": decimal, "monthPrev4": decimal, "monthPrev3": decimal, "monthPrev2": decimal, "monthPrev1": decimal, } ], }