getWorkflowThrottleUsage
Daily send-limit usage for a throttle-backed workflow.
Daily send-limit usage for a throttle-backed workflow (by group id): usedToday vs dailyCap and a per-day history over the last rangeDays (1-90, clamped). Null for a workflow with no throttle (only skip-trace-category workflows have one). Answers "am I near my sending limit?".
curl https://server.goliathdata.com/api/v1/call \
-H "Authorization: Bearer $GOLIATH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"operationId": "getWorkflowThrottleUsage",
"variables": {
"workflowGroupId": "<workflowGroupId>",
"rangeDays": 10
}
}'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.getWorkflowThrottleUsage({
workflowGroupId: '<workflowGroupId>',
rangeDays: 10
})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: 'getWorkflowThrottleUsage',
variables: {
workflowGroupId: '<workflowGroupId>',
rangeDays: 10
}
}),
})
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": {
"workflowGroupThrottleUsage": {
"throttleType": "…",
"dailyCap": 0,
"usedToday": 0,
"history": [
{
"day": "2026-01-01T00:00:00.000Z",
"unitsSent": 0
}
]
}
}
}
}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.