API Guide

With our API, you can conveniently manage all your workflows that have monitoring enabled. You can:

• Get all active workflows that have monitoring enabled.
• Get historical data changes for one or multiple workflows.

​

Get All Active Monitoring Workflows

Use the following endpoint to retrieve your workflows:

GET /v4/workflows

See API Reference

The response will include all workflows that are in your scope (user, team, organization).

To get all workflows that are active and have real-time monitoring enabled, you can use the following query parameter:

?state=ACTIVE&monitoring=true&updateInterval=REAL_TIME

​

Example Request

Fetch all workflows that are active and have real-time monitoring enabled with a limit of 100:

curl -X GET "https://api.kadoa.com/v4/workflows?limit=100&state=ACTIVE&monitoring=true&updateInterval=REAL_TIME" \
  -H "x-api-key: YOUR_API_KEY"

​

Get Changes for Workflows

The following endpoint returns historical data changes detected by your monitoring workflows. A “change” means the monitor spotted a relevant change in the data since the last check.

GET /v4/changes

See API Reference

​

Example Request

Fetch all recorded changes for all workflows:

curl -X GET "https://api.kadoa.com/v4/changes" \
  -H "x-api-key: YOUR_API_KEY"

Fetch changes in a specific time range for specific workflows:

curl -X GET "https://api.kadoa.com/v4/changes?workflowIds=123456789,987654321&startDate=2024-11-01T00:00:00Z&endDate=2024-11-30T23:59:59Z" \
  -H "x-api-key: YOUR_API_KEY"

​

Diff Field Explanation

Each change includes a diff array that shows what changed between checks. Each entry in diff represents text that was added or removed.

• value: The text that changed.
• added: true if this text is new in the latest version.
• removed: true if this text was removed.
• count: How many lines the changed text includes.