Skip to content
Dashboard
API Reference

List Storage Batches ​

List batch windows and their exact agent_state_id/run linkage. folder_id matches the stable Drive/Dropbox batch folder identity. batch_key can select S3 or older path-based batches.

Required scope: triggers:read. See API key permissions and the pipeline dashboard guide.

Request ​

bash
curl "https://api.mosaic.so/storage_batches?limit=25" \
  -H "Authorization: Bearer mk_your_api_key" \
  -H "X-Workspace-Id: 66666666-6666-4666-8666-666666666666"

Workspace IDs and resource IDs above are examples. Use IDs returned by your own API calls.

Parameters ​

ParameterLocationMeaning
limitqueryPage size from 1 to 100; default 25. Progress and notification configuration pages count tiles.
cursorqueryOpaque next_cursor from the previous page. Pass verbatim and preserve the original filters. Do not decode or construct it.
fromqueryInclusive ISO 8601 lower bound on creation time.
toqueryInclusive ISO 8601 upper bound on creation time.
updated_fromqueryInclusive ISO 8601 update watermark. Restart pagination on each poll and fetch every page before advancing it.
workspace_idqueryOptional workspace UUID within the key organization. Must match X-Workspace-Id when both are supplied.
trigger_idquerytrigger id UUID.
agent_idqueryOriginating agent UUID.
folder_idqueryProvider parent folder ID for event/folder queries; batches use batch_folder_node_id.
batch_keyqueryExact grouping key.
statusqueryExact persisted status; for example pending for events or open for batches.
X-Workspace-IdheaderRestrict requests to an authorized workspace UUID. Omit to query the organization.

Response example ​

json
{
  "batches": [
    {
      "id": "33333333-3333-4333-8333-333333333333",
      "storage_trigger_subscription_id": "22222222-2222-4222-8222-222222222222",
      "agent_id": "11111111-1111-4111-8111-111111111111",
      "batch_key": "production-7",
      "batch_folder_node_id": "drive-folder-7",
      "status": "flushed",
      "opened_at": "2026-10-15T12:00:00Z",
      "last_event_at": "2026-10-15T12:00:00Z",
      "scheduled_flush_at": "2026-10-15T12:01:00Z",
      "asset_count": 2,
      "created_at": "2026-10-15T12:00:00Z",
      "updated_at": "2026-10-15T12:01:00Z",
      "agent_state_id": "44444444-4444-4444-8444-444444444444",
      "retry_count": 0,
      "last_error": null,
      "error_message": null,
      "stage": "processing",
      "run": {
        "id": "44444444-4444-4444-8444-444444444444",
        "agent_id": "11111111-1111-4111-8111-111111111111",
        "workspace_id": "66666666-6666-4666-8666-666666666666",
        "status": "running",
        "status_message": null,
        "created_at": "2026-10-15T12:00:00Z",
        "updated_at": "2026-10-15T12:01:00Z",
        "trigger_info": {
          "source_folder_id": "drive-folder-7",
          "batch_window_id": "33333333-3333-4333-8333-333333333333",
          "storage_trigger_subscription_id": "22222222-2222-4222-8222-222222222222"
        }
      }
    }
  ],
  "next_cursor": null
}

Batches values ​

FieldMeaning
idBatch window ID; use as batch_id in item requests and run filters.
storage_trigger_subscription_idOriginating storage trigger ID.
agent_idOriginating agent ID.
agent_state_idExact linked run ID; null until a run is linked.
batch_keyBatch grouping key; preserve it verbatim in filters.
batch_folder_node_idStable batching folder identifier. This is the folder_id accepted by the batches endpoint; it may differ from a provider parent folder ID.
statusPersisted batch status, such as open, flushing, flushed, cancelled, or failed.
stageDashboard stage derived from persisted batch and linked run state; never implies Slack delivery.
asset_countRecorded asset count.
retry_countBatch retry count.
last_errorMost recent batch error.
error_messageBatch error details.
opened_atWhen the batch window opened.
last_event_atLast observed event in this batch.
scheduled_flush_atEarliest scheduled flush time; this is not a run completion estimate.
created_atBatch creation time.
updated_atBatch update time.
runSee nested schema in the API reference.

When next_cursor is non-null, request the next page with the same filters and that cursor. limit defaults to 25 and is capped at 100. Read the polling and error-handling guidance before building a dashboard.