Description
The CATEGORY function fetches one category of a company's scorecard (for example Environmental) for a rubric and reporting period from the Novata API.
Syntax
=NOV.CATEGORY(company, rubric, reportingPeriod, category, fieldName)
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
company |
String | Required | Company name as shown on the scorecard (e.g. "The Clean Co"), or its Company Id. |
rubric |
String | Required | Rubric name (e.g. "ESG Rubric") or Rubric Id. A name always means the active rubric; use the Rubric Id for an archived rubric. |
reportingPeriod |
String | Required | Reporting period, in the same formats as NOV.ANSWER: "2024", "Q3 2024", "H1 2024" or "Jan 2025". |
category |
String | Required | Category name as shown on the scorecard (not case-sensitive). |
fieldName |
String | Required | The category field to return (see available fields below). |
Available Field Names
You can use any of the following field names as the fieldName parameter:
score
Category score
max_score
Highest possible category score
weight
Category weight in the total
Examples
Example 1: Get a category score
=NOV.CATEGORY("The Clean Co", "ESG Rubric", "2024", "Environmental", "score")
Result: 8
Example 2: Get a category weight
=NOV.CATEGORY("The Clean Co", "ESG Rubric", "Q3 2024", "Governance", "weight")
Result: 40
Important Notes
Note:
- Company, rubric, category and question names match what the Scorecard Management panel inserts, ignoring case and surrounding spaces.
- A rubric name only matches the active rubric. For a rubric that has been archived, use its Rubric Id.
- Archived scorecards are ignored.
- Field names are case-sensitive. Use the exact field names listed above.
- Make sure you're logged into the Novata Excel Add-in before using this function.
Related Functions
NOV.SCORE - Retrieve scorecard totals
NOV.QUESTION - Retrieve scorecard question data
NOV.ANSWER - Retrieve answer data
NOV.COMP - Retrieve company attributes