Skip to content

list_data_source_snapshots

List every current, historical, detached, and reclaimed snapshot generation for one data source, covering both file-upload and Google Sheet layouts (unlike the legacy list_snapshots, which only sees timestamped GSheet batches). Use this before detach_data_source or delete_data_source_snapshot to find a snapshot_id and check whether it is deletable.

read-only · idempotent

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes
data_source_idAnnotated[str, Field(description='Data source ID, as returned by list_data_sources.')]Yes
max_resultsAnnotated[int, Field(ge=1, le=MAX_SNAPSHOT_RESULTS, description='Maximum snapshot generations to return (default 50, max 200).')]NoDEFAULT_SNAPSHOT_RESULTS
workspace_id`Annotated[strNone, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone

Returns a structured object. Top-level fields:

  • model_name (string)
  • data_source_id (string)
  • source_name (string)
  • source_type (string)
  • source_detached (boolean)
  • snapshots (array<object>)
  • total_count (integer)
  • truncated (boolean)
  • workspace_id (string)

See the response example below for the full payload shape.

{
"name": "list_data_source_snapshots",
"arguments": {
"model_name": "forecasts",
"data_source_id": "6e00ea4c-239d-4ac8-a3eb-ceedca558c78"
}
}
{
"model_name": "forecasts",
"data_source_id": "6e00ea4c-239d-4ac8-a3eb-ceedca558c78",
"source_name": "budget_inputs",
"source_type": "file_upload",
"source_detached": false,
"snapshots": [
{
"snapshot_id": "1a07aedc-9e01-4210-9b78-bdb670797f69",
"source_kind": "upload",
"generation": 2,
"created_at": "2026-04-28T10:00:00+00:00",
"published_at": "2026-04-28T10:00:05+00:00",
"state": "current",
"readiness": "ready",
"cleanup_state": "published_current",
"referenced": true,
"deletable": false,
"object_count": 1,
"total_size_bytes": 2048
},
{
"snapshot_id": "20f6e5b1-ca46-44e2-9134-2dc8db53ebf7",
"source_kind": "upload",
"generation": 1,
"created_at": "2026-04-01T09:00:00+00:00",
"published_at": "2026-04-01T09:00:05+00:00",
"state": "historical",
"readiness": "ready",
"cleanup_state": "published_historical",
"referenced": false,
"deletable": true,
"object_count": 1,
"total_size_bytes": 1900
}
],
"total_count": 2,
"truncated": false,
"workspace_id": "6e00ea4c-239d-4ac8-a3eb-ceedca558c78"
}
  • Module: Data
  • Requires authentication via API token or Auth0 JWT.