Overview
The Pipeline Status API helps you monitor the health and freshness of your Kroo data pipelines. Use it to:- Track data freshness - See when each pipeline last synced data
- Determine data availability - View scheduled next sync times for planning
- Identify sync issues - Spot pipelines that haven’t updated recently
- Create dashboards - Build PowerBI reports for real-time monitoring
- Set up alerts - Get notified when data becomes stale
This is particularly useful for data engineers and project managers who need to ensure critical construction data is up-to-date for reporting and decision-making.
Quick Start
Get Your API Credentials
Test Your Connection
Try this quick test to see your available data partners:- Windows (PowerShell)
- Windows (Command Prompt)
- Mac/Linux
API Reference
Get Available Partners
Endpoint:GET /api/v1/pipeline_status/describe
Discover which data integration partners are configured in your Kroo instance.
Get Pipeline Status
Endpoint:GET /api/v1/pipeline_status?partner={partner_name}&filters[]={pipeline_key}
Retrieve the last sync timestamp for all pipelines from a specific partner.
Query Parameters:
partner(required) - The name of the integration partner (e.g., “procore”, “cmic”)filters[](optional) - Pipeline keys to include in the response. When specified, only these pipelines will be returned. Can be specified multiple times to include multiple pipelines. If omitted, all pipelines are returned
Multiple Filters Syntax: To include multiple pipelines, repeat the The
filters[] parameter:[] brackets indicate an array parameter. Each repetition adds another pipeline to include.- Basic Request
- With Filters
- Windows (PowerShell)
Understanding the Response:
- Timestamps show the last successful sync in ISO 8601 format
nullvalues indicate pipelines that haven’t synced yet or are disabled- All times include timezone information for accurate tracking
Get Next Sync Times
Endpoint:GET /api/v1/pipeline_status/next_sync_times?partner={partner_name}&filters[]={pipeline_key}
Retrieve the scheduled next sync time for all pipelines from a specific partner. This helps you anticipate when fresh data will be available.
Query Parameters:
partner(required) - The name of the integration partner (e.g., “procore”, “cmic”)filters[](optional) - Pipeline keys to include in the response. When specified, only these pipelines will be returned. Can be specified multiple times to include multiple pipelines. If omitted, all pipelines are returned
Multiple Filters Syntax: To include multiple pipelines, repeat the The
filters[] parameter:[] brackets indicate an array parameter. Each repetition adds another pipeline to include.- Basic Request
- With Filters
- Windows (PowerShell)
Understanding the Response:
- Timestamps show the scheduled next sync time in ISO 8601 format
- Use this to plan around data availability for time-sensitive reports
- Combine with last sync times to understand the full sync schedule
PowerBI Dashboard Setup
Create a real-time pipeline monitoring dashboard in PowerBI:Connect to the API
- Open PowerBI Desktop and create a new report
- Click Get Data > Web
- Enter URL:
https://api.getkroo.com/api/v1/pipeline_status?partner=procore - Select Basic authentication and enter your Kroo credentials
Transform the Data
In Power Query Editor:
- Convert to Table - Click Convert > To Table
- Expand Columns - Select Name and Value columns
- Rename Columns - Change to “Pipeline” and “Last Sync Time”
- Set Data Types - Text for Pipeline, Date/Time for Last Sync Time
- Remove Nulls - Filter out rows with null sync times
- Click Close & Apply
Build Visualizations
Create useful charts and tables:
- Status Table - All pipelines with sync times
- Freshness Cards - Show oldest/newest sync times
- Alert Visuals - Highlight stale data (>24 hours old)
- Timeline Charts - Track sync patterns over time
Common Use Cases
Monitoring Critical Pipelines
Set up alerts for business-critical data:Operations Dashboard
Create executive dashboards showing:- Overall data health status
- Pipeline performance trends
- Integration partner reliability
- Data availability for key reports
Troubleshooting Data Issues
When reports show unexpected data:- Check pipeline status to identify sync delays
- Compare sync times across related pipelines
- Coordinate with Kroo support using specific pipeline names and timestamps
Pro Tip: Bookmark your PowerBI dashboard and check it before running important reports to ensure you’re working with fresh data.