Get Bulk Calculate Batch
Status of a bulk-calculate batch. While it runs, progressPercent and summary advance and items is null; the Location and Retry-After headers say where and how soon to poll. Once state is completed or failed, items lists every requested item in request order and the poll headers are gone.
Authorizations
Headers
Path Parameters
Response
The batch's current status; items is present only once the batch is terminal.
A bulk-calculate batch. The same body is returned when the batch is accepted and on every poll; items is null until state is terminal. Clients must tolerate state values not listed here.
processing while sheets are being created and solved. completed once every item has an outcome; items that could not be solved carry their own error, so a completed batch can have summary.solved of 0. failed when the batch itself could not run, or when it stopped before finishing and will not resume (see error). Treat an unrecognised value as still in progress.
Counts over the items. pending is total - solved - errored - stale and is 0 once the batch is terminal, where every item is solved or carries an error. The three non-solved counters answer different questions and are never folded together, because the remedy differs: errored counts items the batch could not produce results for, where retrying is the fix; stale counts items it did solve whose inputs have changed since, where nothing failed and re-solving the sheet is the fix; checkErrored counts items that solved but whose governing check produced no verdict, and those are also counted in solved. To confirm every item is usable, check errored, stale and checkErrored are all 0. state is the completion signal. While processing the counts are progress, and pending can read 0 in the moments between the last sheet solving and the batch reaching a terminal state; do not use it to detect completion. On a terminal batch the counters are recomputed from the sheets' current state on every poll, so the same batchId can report different counts later if its sheets are edited or deleted.