This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a query to retrieve a list of referring customers.
The queryReferringCustomers() function builds a query to retrieve a list of events and returns a ReferringCustomersQueryBuilder object.
The returned object contains the query definition, which is typically used to run the query using the find() function.
You can refine the query by chaining ReferringCustomersQueryBuilder functions onto the query. ReferringCustomersQueryBuilder functions enable you to sort, filter, and control the results queryReferringCustomers() returns.
queryReferringCustomers() runs with these ReferringCustomersQueryBuilder defaults, which you can override:
limit(50)descending("_createdDate")
The functions that are chained to queryReferringCustomers() are applied in the order they're called. For example, if you apply ascending('referralCode') and then descending('contactID'), the results are sorted first by the referral code, and then, if there are multiple results with the same referral code, the items are sorted by contact ID.| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
contactId | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
referralCode | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
_createdDate | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
_updatedDate | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.