Get batch summary | Runtype Documentation

{
  "activeBatches": 2,
  "batches": [
    {
      "failedRecords": 3,
      "flowName": "User Data Import",
      "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
      "processedRecords": 97,
      "progress": 75,
      "startedAt": "2024-06-10T09:15:00Z",
      "status": "running",
      "totalRecords": 130
    }
  ],
  "recent": [
    {
      "failedRecords": 0,
      "flowName": "Monthly Report Generation",
      "id": "f1234567-89ab-cdef-0123-456789abcdef",
      "processedRecords": 500,
      "progress": 100,
      "startedAt": "2024-06-09T22:00:00Z",
      "status": "completed",
      "totalRecords": 500
    }
  ],
  "recentlyCompleted": 5
}

Returns a summary of active and recently completed batch executions for the current user.

Authentication

AuthorizationBearer

API key or Clerk session token

Response

Batch summary

activeBatchesinteger

batcheslist of objects

recentlist of objects

recentlyCompletedinteger

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

$	curl https://api.runtype.com/v1/batch/summary \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json"