Appointment7

Appointment Availability1

Booking4

Branch1

Branch Service4

Branch WorkTimeTable1

Break5

CheckIn1

Client8

Client Course3

Client Credit Account Transaction1

ClientCategory2

Course1

CSV Export Job2

Deposit1

Inventory Transaction1

Lead4

Loyalty Points1

Machine2

PaymentType2

Product1

Purchase1

Review2

Room2

SaleFee3

Service Category1

Service Package1

Service Special Offer1

Staff3

Staff WorkTimeTable1

Stock1

Tax2

Till2

Till Session1

Time Off Policy2

Voucher4

Lead

Get leads stats

List total leads, total conversions, number of leads and conversions made over the past 30 days, and rate of conversions over the past 30 days.

get/api/business/{businessId}/branch/{branchId}/leads/stats

Request

Base URL
http://api-gateway-eu.phorest.com/third-party-api-server
Auth
HTTP basic
TypeScript
https://skmtc.dev/phorest/apis/third-party-api/docs/api/business/:businessId/branch/:branchId/leads/stats/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

businessIdstring required

branchIdstring required

Response

Leads stats listed

totalLeadsinteger

Total number of leads created

totalConversionsinteger

Total number of leads converted

leads30Dayinteger

Number of leads created in the past 30 days

conversions30Dayinteger

Number of leads converted in the past 30 days

conversionRate30Daynumber double

Rate of lead conversion over the past 30 days

Example response

{
  "totalLeads": 13,
  "totalConversions": 3,
  "leads30Day": 5,
  "conversions30Day": 2,
  "conversionRate30Day": 2
}

Changes

No recorded changes to this operation across all 2 revisions of this API.