Check search-index rebuild progress
reindex_statusReports progress and state of the current or last search-index rebuild so you can poll after an execute request and judge whether search results may be incomplete; it never starts or resumes rebuilds.
Instructions
Report the progress of the current or last search-index rebuild; contacts no Bridge and changes nothing.
Use it to poll after reindex(op="execute"), or to judge whether search results may be incomplete. It never starts or resumes a rebuild: use reindex for that.
Returns state (idle, rebuilding, running, succeeded, failed or cancelled), progress, ETA, last error, run_id and the swap outcome and reason. last_full_run groups the current or last full rebuild's old_count, new_count and all_mail_count: last_full_run.all_mail_count is the count at that full rebuild, while top-level all_mail_count is the live count from the latest locally observed inventory, beside all_mail_max_uid and all_mail_observed_at. indexed_count and indexed_max_uid always read the serving index. target is the last observed All Mail total; percent is indexed_count divided by target, clamped to 0..100 (100 for an empty target, null if unknown). last_catchup_at is the last incremental sync or committed automatic recovery batch; last_expunge_reconciliation_at the last inventory reconciliation. Timestamps survive restart, unavailable fields are null, and UID maxima are strings ("0" when empty).
A manual rebuild's progress and ETA include All Mail and real-folder header copies. Automatic startup recovery reports source="auto" and state="rebuilding", counts All Mail only and reports success after real folders are also checked; max_uid then aliases all_mail_max_uid, and last_full_run still describes the manual rebuild. Its ETA is null until new indexed headers give an observed rate. A previous successful run never reports succeeded while headers are missing. With the optional background sync on, a background_sync object adds active, last_outcome and last_skip_reason (fixed codes), last_tick_at, commands_today, rows_today and their daily limits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||