Skip to content

refresh_google_sheet_snapshot

Refresh a connected Google Sheet snapshot for a model. Requires an existing Bridge Town connection and may call Google APIs.

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes
source_name`Annotated[strNone, Field(description=‘Connected sheet source name; provide this or data_source_id.’)]`NoNone
data_source_id`Annotated[strNone, Field(description=‘Connected sheet data-source UUID; provide this or source_name.’)]`NoNone
tab_names`Annotated[list[str]None, Field(description=‘Tabs to snapshot; defaults to all tabs.’)]`NoNone
schedule_interval_minutes`Annotated[intNone, Field(description=‘Optional refresh cadence in minutes.’)]`NoNone
workspace_id`Annotated[strNone, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone

Returns a structured object. Top-level fields:

  • model_name (string)
  • source_name (string)
  • source_type (string)
  • data_source_id (string)
  • spreadsheet_id (string)
  • snapshot_taken_at (string)

See the response example below for the full payload shape.

{
"name": "refresh_google_sheet_snapshot",
"arguments": {
"model_name": "forecasts",
"source_name": "headcount_sheet",
"tab_names": [
"Roles",
"Hires"
],
"schedule_interval_minutes": 60
}
}
{
"model_name": "forecasts",
"source_name": "headcount_sheet",
"source_type": "google_sheets",
"data_source_id": "88888888-8888-8888-8888-888888888888",
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG",
"snapshot_taken_at": "2026-04-28T10:00:00+00:00"
}
  • Module: Data
  • Requires authentication via API token or Auth0 JWT.