Custom Metrics

Documentation Index

Fetch the complete documentation index at: https://docs.keystn.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

While the built-in analytics modules cover common use cases, every mortgage operation has unique questions. Custom Metrics gives you a flexible query builder that lets you define, save, and evaluate metrics tailored to your specific needs.

​

Creating a Custom Metric

To create a metric, navigate to Analytics > Custom and click the button to add a new metric.

​

Metric Definition Fields

​

Configuration

The metric configuration controls what data is queried and how it is processed.

​

Aggregation

Choose how to compute the result:

​

Field

Select which loan field to aggregate: Note: When using the Count aggregation, the field selection is less important since Count simply counts matching records.

​

Date Field

Choose which date field is used for date range filtering:

​

Filters

Add one or more filters to narrow which loans are included in the calculation. Each filter specifies a field, an operator, and a value. Available operators: Example filters:

• Loan Purpose = Purchase — Only purchase loans
• Loan Type is one of FHA, VA — Only FHA and VA loans
• Loan Amount >= 500000 — Only loans above $500K

​

Group By

Optionally group results to see the metric broken down by a dimension: When a group-by is set, the metric returns both an overall value and a breakdown by group, sorted by value descending.

​

Visualization

Choose how the metric is displayed:

​

Comparison Period

Optionally enable a comparison to a prior time range: When enabled, the metric result includes both the comparison value and the percentage change.

​

Evaluating a Metric

Once created, a metric can be evaluated for any date range. The evaluation engine applies the metric’s filters, date range, and aggregation to matching loans. If a group-by is configured, results are broken down by that dimension. If a comparison period is enabled, prior-period values are calculated alongside the current period.

​

Result Structure

Each evaluation produces:

​

Managing Custom Metrics

​

Pinning

Pin important metrics to keep them at the top of the dashboard. Pinned metrics appear first, followed by unpinned metrics sorted by display order and creation date.

​

Editing

Click on a metric to modify its name, description, configuration, or pinned status. Changes take effect immediately for all future evaluations.

​

Deleting

Deleting a metric hides it from the dashboard but retains the record.

​

Example Metrics