getWorkflowVersionStats
Performance summary for one VERSION.
Performance summary for one VERSION (by workflowAutomationId, from getWorkflow.versions), the shape of getWorkflowStats: compare a new version against the one it replaced. Also sendingCapacity: how many of its runs are queued behind sending capacity now (queuedRuns), the soonest nextAttemptAt and the main reason (DAILY_CAP | SEND_WINDOW | WINDOW_LIMIT | OUT_OF_SMS_CREDITS); null when nothing is queued. It tells a workflow that is PACING from one that has stopped.
curl https://server.goliathdata.com/api/v1/call \
-H "Authorization: Bearer $GOLIATH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"operationId": "getWorkflowVersionStats",
"variables": {
"workflowAutomationId": "<workflowAutomationId>"
}
}'import { GoliathClient } from '@goliath-data/sdk'
const goliath = new GoliathClient({
apiKey: process.env.GOLIATH_API_KEY!,
baseUrl: 'https://server.goliathdata.com',
})
const result = await goliath.workflows.getWorkflowVersionStats({
workflowAutomationId: '<workflowAutomationId>'
})const res = await fetch('https://server.goliathdata.com/api/v1/call', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
operationId: 'getWorkflowVersionStats',
variables: {
workflowAutomationId: '<workflowAutomationId>'
}
}),
})
const { data, errors } = await res.json()Variables
The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.
Response
What comes back under data: a list shows as one entry, and a value as its type.
{
"data": {
"workflowAutomationsQuery": {
"workflowAutomation": {
"id": "<ID>",
"name": "…",
"status": "DRAFT",
"stats": {
"totalRuns": 0,
"activeRuns": 0,
"completedRuns": 0,
"pausedRuns": 0,
"stoppedRuns": 0,
"failedRuns": 0,
"messagesSent": 0,
"sentEmailCount": 0,
"sentTextCount": 0,
"bouncedEmailCount": 0,
"failedTextCount": 0,
"replyRate": 0,
"bounceRate": 0,
"positiveReplyRate": 0,
"negativeReplyRate": 0,
"positiveReplyCount": 0,
"negativeReplyCount": 0,
"genuineReplyCount": 0,
"optOutReplyCount": 0,
"unreachableReplyCount": 0
},
"sendingCapacity": {
"queuedRuns": 0,
"nextAttemptAt": "2026-01-01T00:00:00.000Z",
"reason": "DAILY_CAP"
}
}
}
}
}Errors
unknown_variableA variable the operation does not declare. A typo is refused rather than silently dropped.
unauthorizedNo bearer header, or the key is invalid or revoked.
insufficient_scopeThe key lacks the scope the operation requires.
forbiddenA referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.
Behaviour
A read. It rejects an Idempotency-Key header with 400 bad_request.