NOV.METRIC Function - Novata Excel Add-in Documentation

Description

The METRIC function fetches specific field values for a metric from the Novata API. This function allows you to retrieve metric metadata such as name, definition, type, unit, and guidance by providing the metric ID and the desired field name.

Syntax

=NOV.METRIC(metricId, fieldName)

Parameters

Parameter	Type	Required	Description
`metricId`	String	Required	Unique identifier for the metric in the Novata system.
`fieldName`	String	Required	The name of the field you want to retrieve (see available fields below).

Available Field Names

You can use any of the following field names as the second parameter:

metric_name

Name of the metric

metric_definition

Full definition of the metric

metric_definition_summary

Summary of the metric definition

metric_type

Input type ID for the metric

metric_unit

Unit of measurement for the metric

metric_guidance

Guidance for the metric

metric_guidance_content

Detailed guidance content

Examples

Example 1: Get Metric Name

=NOV.METRIC("MTR-001", "metric_name")

Result: "Total GHG Emissions"

Example 2: Get Metric Definition

=NOV.METRIC("MTR-001", "metric_definition")

Result: "Total greenhouse gas emissions in metric tons of CO2 equivalent, including Scope 1, 2, and 3 emissions."

Example 3: Get Metric Definition Summary

=NOV.METRIC("MTR-002", "metric_definition_summary")

Result: "Total energy consumption across all operations"

Example 4: Get Metric Unit

=NOV.METRIC("MTR-001", "metric_unit")

Result: "metric tons CO2e"

Example 5: Get Metric Type

=NOV.METRIC("MTR-003", "metric_type")

Result: "numeric"

Example 6: Get Metric Guidance

=NOV.METRIC("MTR-001", "metric_guidance")

Result: "Include all direct and indirect emissions from operations"

Example 7: Get Detailed Guidance Content

=NOV.METRIC("MTR-002", "metric_guidance_content")

Result: "Measure energy consumption from all sources including electricity, natural gas, and renewable energy. Report in megawatt-hours (MWh)."

Important Notes

Note:

Both parameters are required. The function will return an error if either is missing.
The metricId must be a valid metric ID from the Novata system.
Field names are case-sensitive. Use the exact field names listed above.
If the field doesn't exist or the metric is not found, the function will return an error message.
The metric_definition field may contain lengthy text, so ensure your cell is properly formatted.
Make sure you're logged into the Novata Excel Add-in before using this function.

Related Functions

NOV.FUND - Retrieve fund attributes
NOV.COMP - Retrieve company attributes
NOV.ANSWER - Retrieve answer data
NOV.REPORT - Retrieve report information