AiHummer
English▾
Sign inAccount
v1.6.x▾
{ }Swagger

Approved business metrics

v1.6.x · updated 2026-11-15

Open Analytics → Approved business metrics. Registry management is available to the current Owner or administrator. Calculations also require an accessible agent, its permitted database-read capability, and your current data permissions.

An approved metric defines what a number means. It includes its business domain and name, exact version, owner, effective dates, units or currency, calendar and time zone, parameters, fixed query, expected result fields, and check cases. A question written in chat does not create an approved definition.

Prepare and approve a definition

  1. Select the workspace and the agent that has the intended data access.
  2. Select an existing version to inspect it, or choose Create a new version to prepare a separate draft.
  3. Open Definition, query and expected checks. Use your team’s reviewed definition, including its calendar, result rules, and representative expected checks. This configuration requires knowledge of the source and query; it is not an unrestricted query box for ordinary reporting.
  4. Select Read actual source metadata to bind the definition to the configured source.
  5. Save the draft, then select Run approved check cases.
  6. Inspect the check results before approving the exact draft.

Passing check cases demonstrates those cases. It does not prove that a formula is correct for every business situation. Approval must reflect the business meaning as well as the expected values.

Saved versions retain their own definition. Change a formula, calendar, parameter rule, or source binding by creating and checking a new version rather than silently changing an approved calculation. Deprecation records a reason and retains history; it is not deletion of earlier results.

Calculate a metric

  1. Select the intended metric version and current agent.
  2. Open the calculation section.
  3. Enter the Business effective date and the exact named parameters required by that definition.
  4. Select Calculate and inspect the returned values and observation time.

For example, two similarly named revenue metrics may use different calendars, currencies, or treatment of returns. Compare those definitions before comparing their totals. The effective date selects the applicable business logic; it does not turn a current database read into a historical database snapshot.

Calculations run read-only through the configured database connection. Your current row-level permissions and the agent’s restrictions still apply. Registry access or knowledge of a metric’s name does not grant access to another person’s rows. A required approval or unavailable read capability cannot be bypassed by selecting a different display name.

Understand a refusal or changed result

Changes to the source structure, source rules, or current permissions can make a formerly valid definition unavailable. Refresh the catalog and have the source and definition checked again. Do not remove source checks to force an old definition to run.

An unavailable result is different from an empty result or a numeric zero. A successful read establishes the returned calculation under that source and account; it does not establish that a separate business action was completed.

If a save, approval, or deprecation loses its acknowledgement, select Refresh before repeating the change. Inspect the saved state first.

To retain a question and exact calculation version for later reading, see Saved analyses and business record links.