NOV.REPORT Function - Novata Excel Add-in Documentation

Description

The REPORT function fetches specific report field values from the Novata API. This function allows you to retrieve report metadata such as status, completion percentage, due dates, framework information, and timestamps by providing the report ID, name, reporting period, and desired field name.

Syntax

=NOV.REPORT(reportId, reportName, reportingPeriod, fieldName)

Parameters

Parameter	Type	Required	Description
`reportId`	String	Required	Unique identifier for the report.
`reportName`	String	Required	Name of the report.
`reportingPeriod`	String	Required	Reporting period (e.g., "2024", "2023-Q4").
`fieldName`	String	Required	The name of the report field you want to retrieve (see available fields below).

Available Field Names

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

Data Provider Information

data_provider_name

Name of the data provider

data_provider_sics_industry

SICS industry of the data provider

Report Metadata

report_name

Name of the report

framework_name

Name of the reporting framework

reporting_period

Reporting period

report_period_frequency

Frequency of the reporting period

report_period_start

Start date of the reporting period

Report Status & Progress

report_status

Current status of the report

report_completion

Completion percentage of the report

Important Dates

report_due_date

Due date for the report

report_created_at

Date when report was created

report_updated_at

Date when report was last updated

report_submitted_at

Date when report was submitted

Examples

Example 1: Get Report Status

=NOV.REPORT("RPT-001", "Annual ESG Report", "2024", "report_status")

Result: "Submitted"

Example 2: Get Report Completion Percentage

=NOV.REPORT("RPT-001", "Annual ESG Report", "2024", "report_completion")

Result: 95.5

Example 3: Get Data Provider Name

=NOV.REPORT("RPT-002", "Sustainability Report", "2024", "data_provider_name")

Result: "Tech Innovations Inc."

Example 4: Get Framework Name

=NOV.REPORT("RPT-001", "Annual ESG Report", "2024", "framework_name")

Result: "SASB"

Example 5: Get Report Due Date

=NOV.REPORT("RPT-003", "Q4 Report", "2023-Q4", "report_due_date")

Result: "2024-01-31"

Example 6: Get Report Created Date

=NOV.REPORT("RPT-001", "Annual ESG Report", "2024", "report_created_at")

Result: "2024-01-15T10:30:00Z"

Example 7: Get Report Submitted Date

=NOV.REPORT("RPT-002", "Sustainability Report", "2024", "report_submitted_at")

Result: "2024-03-20T14:45:00Z"

Example 8: Get Report Updated Date

=NOV.REPORT("RPT-001", "Annual ESG Report", "2024", "report_updated_at")

Result: "2024-03-18T09:15:00Z"

Example 9: Get Reporting Period Frequency

=NOV.REPORT("RPT-003", "Quarterly Report", "2024-Q1", "report_period_frequency")

Result: "Quarterly"

Example 10: Get Reporting Period Start Date

=NOV.REPORT("RPT-001", "Annual ESG Report", "2024", "report_period_start")

Result: "2024-01-01"

Example 11: Get Data Provider SICS Industry

=NOV.REPORT("RPT-002", "Sustainability Report", "2024", "data_provider_sics_industry")

Result: "Software & IT Services"

Important Notes

Note:

All four parameters are required. The function will return an error if any is missing.
The reportId must be a valid report identifier from the Novata system.
The reportName should match the exact report name as it appears in Novata.
The reportingPeriod should match the format used in your Novata reports (e.g., "2024", "2023-Q4").
Field names are case-sensitive. Use the exact field names listed above.
Date fields return ISO 8601 formatted timestamps. You may need to format them in Excel.
The report_completion field returns a percentage value (0-100).
If the report doesn't exist or the field is not available, the function will return an error message.
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.METRIC - Retrieve metric information
NOV.ANSWER - Retrieve answer data