Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kadoa.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Understanding Workflow Status

When you view a workflow in the dashboard or API, you’ll see a status that tells you what’s happening. This status is computed from two underlying values.

​
What You See (displayState)

The status shown in the dashboard:
StatusMeaning
CompleteLast run finished successfully, no future runs scheduled
ScheduledLast run finished successfully, future runs are scheduled
DraftWorkflow exists but setup is still incomplete, so it is not ready to run yet
RunningA job is currently extracting data, or a real-time monitor is collecting data normally
ValidatingRun finished extraction and Kadoa is validating it before delivering data
FailedLast run encountered an error
Degraded(Real-time monitors only) No data received for more than 15 minutes
PausedWorkflow is paused
Needs ReviewSample data ready for your review
Sample ProcessingKadoa is generating your workflow

​
Real-time monitor health

Real-time monitors run continuously and are health-checked automatically. If a monitor stops receiving data, its status changes: Running → Degraded (after 15 min) → Failed (after 30 min)
  • Degraded — Our team has been notified and is investigating.
  • Failed — A support case has been opened and you’ll be notified when it’s resolved.
Monitors recover to Running automatically once the issue is resolved. This is different from scheduled workflows, where a failed status stays until the next run succeeds.

​
API Response Fields

The API returns three state-related fields: 
{
  "state": "ACTIVE",
  "runState": "FINISHED",
  "displayState": "ACTIVE"
}
FieldPurposeWhen to Use
displayStateWhat users see in the dashboardUse this for filtering and display
stateWorkflow lifecycle (enabled/paused/deleted)Admin operations
runStateLatest job result (running/finished/failed)Job-level debugging
For draft workflows, both state and displayState are DRAFT until the workflow leaves the draft lifecycle.

​
Filtering Workflows

When filtering workflows via the API, use the displayState parameter: 
# Get all completed/scheduled workflows (both show as displayState=ACTIVE)
GET /v4/workflows?displayState=ACTIVE

# Get draft workflows
GET /v4/workflows?displayState=DRAFT

# Get workflows currently being validated before delivery
GET /v4/workflows?displayState=VALIDATING

# Get failed workflows
GET /v4/workflows?displayState=FAILED

# Get paused workflows
GET /v4/workflows?displayState=PAUSED

# Get workflows pending review
GET /v4/workflows?displayState=PREVIEW

# Get degraded monitors
GET /v4/workflows?displayState=DEGRADED
displayState is computed by combining state and runState. For example, a workflow with state=ACTIVE and runState=FAILED will have displayState=FAILED. Some lifecycle states map directly, such as DRAFT, PAUSED, and PREVIEW. For real-time monitors, displayState can also be DEGRADED or FAILED based on monitor health.