List Storage Batches
curl --request GET \
--url https://api.example.com/storage_batchesimport requests
url = "https://api.example.com/storage_batches"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/storage_batches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/storage_batches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/storage_batches"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/storage_batches")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/storage_batches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyPipeline Observability
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.
GET
/
storage_batches
List Storage Batches
curl --request GET \
--url https://api.example.com/storage_batchesimport requests
url = "https://api.example.com/storage_batches"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/storage_batches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/storage_batches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/storage_batches"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/storage_batches")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/storage_batches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyRequired scope:
Workspace IDs and resource IDs above are examples. Use IDs returned by your own API calls.
When
triggers:read. See API key permissions and the pipeline dashboard guide.
Request
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"
Parameters
| Parameter | Location | Meaning |
|---|---|---|
limit | query | Page size from 1 to 100; default 25. Progress and notification configuration pages count tiles. |
cursor | query | Opaque next_cursor from the previous page. Pass verbatim and preserve the original filters. Do not decode or construct it. |
from | query | Inclusive ISO 8601 lower bound on creation time. |
to | query | Inclusive ISO 8601 upper bound on creation time. |
updated_from | query | Inclusive ISO 8601 update watermark. Restart pagination on each poll and fetch every page before advancing it. |
workspace_id | query | Optional workspace UUID within the key organization. Must match X-Workspace-Id when both are supplied. |
trigger_id | query | trigger id UUID. |
agent_id | query | Originating agent UUID. |
folder_id | query | Provider parent folder ID for event/folder queries; batches use batch_folder_node_id. |
batch_key | query | Exact grouping key. |
status | query | Exact persisted status; for example pending for events or open for batches. |
X-Workspace-Id | header | Restrict requests to an authorized workspace UUID. Omit to query the organization. |
Response example
{
"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
| Field | Meaning |
|---|---|
id | Batch window ID; use as batch_id in item requests and run filters. |
storage_trigger_subscription_id | Originating storage trigger ID. |
agent_id | Originating agent ID. |
agent_state_id | Exact linked run ID; null until a run is linked. |
batch_key | Batch grouping key; preserve it verbatim in filters. |
batch_folder_node_id | Stable batching folder identifier. This is the folder_id accepted by the batches endpoint; it may differ from a provider parent folder ID. |
status | Persisted batch status, such as open, flushing, flushed, cancelled, or failed. |
stage | Dashboard stage derived from persisted batch and linked run state; never implies Slack delivery. |
asset_count | Recorded asset count. |
retry_count | Batch retry count. |
last_error | Most recent batch error. |
error_message | Batch error details. |
opened_at | When the batch window opened. |
last_event_at | Last observed event in this batch. |
scheduled_flush_at | Earliest scheduled flush time; this is not a run completion estimate. |
created_at | Batch creation time. |
updated_at | Batch update time. |
run | See nested schema in the API reference. |
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.Was this page helpful?