# getWorkbookIntegrityReport

Reads consistency checks for workbook connections and value propagation.

Canonical: https://grid.syidax.com/docs/methods/getWorkbookIntegrityReport/

<a id="meaning"></a>

## What does this API do?

Reads consistency checks for workbook connections and value propagation.

API for Pro features: Built-in formulas, references, dependency recalculation and calculated columns

<a id="contract"></a>

## Exact input and result types

```typescript
getWorkbookIntegrityReport(): Promise<SyGridWorkbookIntegrityReport>
```

| Arguments | Required | Type |
| --- | --- | --- |

The return type is `Promise<SyGridWorkbookIntegrityReport>`.

<a id="usage"></a>

## Usage flow

After registering and initializing the Grid element, call grid.getWorkbookIntegrityReport(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

<a id="types"></a>

## Read related types

- [SyGridWorkbookIntegrityReport](https://grid.syidax.com/docs/types/SyGridWorkbookIntegrityReport.md)

<a id="recipes"></a>

## Feature explanations and examples

- [Formula calculation](https://grid.syidax.com/docs/features/formulas.md) — Formulas evaluate strings beginning with = and display the result in a cell. For example, =SUM(A1:A3) references the first column in the original column definitions and the first three source rows.