# SyGridWorkbookIntegrityReport

Fields, allowed values, and APIs that use SyGridWorkbookIntegrityReport.

Canonical: https://grid.syidax.com/docs/types/SyGridWorkbookIntegrityReport/

<a id="definition"></a>

## Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

```typescript
export interface SyGridWorkbookIntegrityReport {
  status: 'ok' | 'inactive';
  reason: SyGridWorkbookInactiveReason | null;
  cyclicCells: number;
  cycleDependentCells: number;
  unprovenCells: number;
  provenAcyclicCells: number;
  sheetVerdicts: ReadonlyArray<SyGridWorkbookIntegrityCell>;
  publishingCycleCells: number;
  issue: string;
}
```

<a id="used-by"></a>

## APIs using this type

- [getWorkbookIntegrityReport](https://grid.syidax.com/docs/methods/getWorkbookIntegrityReport.md) — Reads consistency checks for workbook connections and value propagation.

<a id="parents"></a>

## Contracts containing this type

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

<a id="related"></a>

## Related types

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