To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Filter criteria for searching leads within a funnel, used to build a scoped search against the lead search index. Combines a required funnel with optional group, funnel node, created date range and status filters. Built by callers such as LeadmanService and the funnel leads listing, then passed to the search query builder unchanged.
Properties
| Property | Returns | Description |
|---|---|---|
| createdEndDate | Date | Optional upper bound on lead creation date. When set, only leads created on or before this date are included. |
| createdStartDate | Date | Optional lower bound on lead creation date. When set, only leads created on or after this date are included. |
| funnel | Funnel | The funnel that leads are searched within. Required for a search to run - if this is null the search is not performed and no results are returned. |
| group | Group | Optional group to restrict results to. When set, only leads whose profile has a membership in this group are included. |
| nodeId | String | Optional id of the funnel node (the lead's current goal) to restrict results to. |
| status | String | Optional lead status filter: "active" excludes leads with a closed date, "cancelled" requires the lead be marked cancelled, and "closed" requires a closed date. Any other value, or a blank value, applies no status filter. |
Methods
getFunnel()
Returns: Funnel
The funnel that leads are searched within. Required for a search to run - if this is null the search is not performed and no results are returned.
getGroup()
Returns: Group
Optional group to restrict results to. When set, only leads whose profile has a membership in this group are included.
getNodeId()
Returns: String
Optional id of the funnel node (the lead's current goal) to restrict results to.
getCreatedStartDate()
Returns: Date
Optional lower bound on lead creation date. When set, only leads created on or after this date are included.
getCreatedEndDate()
Returns: Date
Optional upper bound on lead creation date. When set, only leads created on or before this date are included.
getStatus()
Returns: String
Optional lead status filter: "active" excludes leads with a closed date, "cancelled" requires the lead be marked cancelled, and "closed" requires a closed date. Any other value, or a blank value, applies no status filter.
© 2025 Kademi Ltd