# getWorkbookSnapshotReport

Reads the last published workbook cells, hashes, and generations. Do not assume all Grid data was published.

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

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

## What does this API do?

Reads the last published workbook cells, hashes, and generations. Do not assume all Grid data was published.

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

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

## Exact input and result types

```typescript
getWorkbookSnapshotReport(): Promise<SyGridWorkbookSnapshotReport>
```

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

The return type is `Promise<SyGridWorkbookSnapshotReport>`.

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

## Usage flow

After registering and initializing the Grid element, call grid.getWorkbookSnapshotReport(…). 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

- [SyGridWorkbookSnapshotReport](https://grid.syidax.com/docs/types/SyGridWorkbookSnapshotReport.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.