Pipeline Status Monitoring

Overview

The v3 Sync Status API lets you monitor the health and freshness of every Kroo sync from your own tools. Use it to:

Track data freshness - See when each endpoint last landed fresh data
Plan around availability - View each endpoint’s next scheduled sync
Diagnose sync issues - Inspect last-run status, duration, and cadence
Monitor utilization - Track partner API-call volume over the last 24 hours
Build dashboards & alerts - Feed PowerBI reports and staleness alerts

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.

The full request and response schema for every endpoint below lives in the API Reference tab. This page is the task-oriented guide. The legacy v1 Pipeline Status API (Basic Auth) is still supported for existing integrations.

Quick Start

The v3 API uses OAuth 2.0 client credentials: exchange your credentials for a short-lived Bearer token, then send that token on each request.

Get API client credentials

Contact implementations@getkroo.com to register an API client. You’ll receive a client_id and client_secret. Treat the secret like a password.

Request an access token

Exchange your credentials at the token endpoint. Request the read:sync_status scope.

Mac/Linux
Windows (PowerShell)

curl --location 'https://api.getkroo.com/api/v3/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=YOUR_CLIENT_ID' \
--data-urlencode 'client_secret=YOUR_CLIENT_SECRET' \
--data-urlencode 'scope=read:sync_status'

Invoke-RestMethod -Uri 'https://api.getkroo.com/api/v3/oauth/token' `
-Method POST `
-ContentType 'application/x-www-form-urlencoded' `
-Body @{
  grant_type    = 'client_credentials'
  client_id     = 'YOUR_CLIENT_ID'
  client_secret = 'YOUR_CLIENT_SECRET'
  scope         = 'read:sync_status'
}

Response:

{
    "access_token": "f4a91d2bce7c4f0a9b8e3d6c5a2f1e8b9d7c6a5b4e3f2d1c0b9a8e7d6c5b4a3f",
    "token_type": "Bearer",
    "expires_in": 3600,
    "scope": "read:sync_status"
}

Call the API with your token

Send the token in the Authorization header as a Bearer credential.

curl --location 'https://api.getkroo.com/api/v3/sync_status?partner=procore' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Tokens expire after 1 hour (expires_in: 3600). Request a new one with the same credentials when it expires. The read:sync_status scope is required for this endpoint.

Sync Status API (v3)

List Sync Status

Endpoint: GET /api/v3/sync_status Returns per-endpoint sync status for your company — one row per sync config, ordered by partner name then endpoint key. Results are paginated and cached for roughly 60 seconds. See the API Reference tab for the complete schema. Query Parameters:

partner (optional) - Integration name to filter to a single partner (e.g. procore). Max 100 characters
page (optional) - 1-indexed page number, clamped to [1, 10000]. Defaults to 1
per_page (optional) - Page size, clamped to [1, 100]. Defaults to 50

Mac/Linux
Windows (PowerShell)

# All partners
curl --location 'https://api.getkroo.com/api/v3/sync_status' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

# Filtered to one partner, second page
curl --location 'https://api.getkroo.com/api/v3/sync_status?partner=procore&page=2&per_page=50' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Invoke-RestMethod -Uri 'https://api.getkroo.com/api/v3/sync_status?partner=procore' `
-Method GET `
-Headers @{'Authorization' = 'Bearer YOUR_ACCESS_TOKEN'}

Sample Response:

{
    "data": [
        {
            "id": "12345",
            "type": "sync_status",
            "attributes": {
                "endpoint_key": "procore_projects",
                "partner_name": "procore",
                "status": "active",
                "last_updated_at": "2025-09-08T07:02:21.876-07:00",
                "next_sync_at": "2025-09-08T13:02:21.876-07:00",
                "last_sync_status": "completed",
                "last_sync_started_at": "2025-09-08T07:00:10.000-07:00",
                "last_sync_finished_at": "2025-09-08T07:02:21.876-07:00",
                "last_sync_duration_seconds": 131,
                "frequency_minutes": 360,
                "api_calls_last_24h": 48
            }
        }
    ],
    "meta": {
        "page": 1,
        "per_page": 50,
        "total_count": 87,
        "total_pages": 2
    }
}

Response Attributes:

Attribute	Description
`endpoint_key`	Sync config key (e.g. `procore_projects`)
`partner_name`	Integration name (e.g. `procore`)
`status`	Config status: `active`, `inactive`, or `webhook`
`last_updated_at`	Data freshness — last completed sync landing time, reconciled across Kroo-native and Fivetran webhook syncs. `null` when nothing has landed since the config’s last recorded sync
`next_sync_at`	Next scheduled sync time. `null` for inactive configs
`last_sync_status`	Last run outcome: `completed`, `failed`, `in_progress`, `timed_out`, or `rate_limited`
`last_sync_started_at`	When the last run started
`last_sync_finished_at`	When the last run finished
`last_sync_duration_seconds`	Duration of the last run in seconds
`frequency_minutes`	Expected sync cadence in minutes
`api_calls_last_24h`	Utilization — count of API calls made to the partner in the last 24 hours (distinct from data freshness)

Pagination: Use meta.total_pages to page through all endpoints. A large integration may span several pages — increase per_page (up to 100) or loop from page=1 to meta.total_pages.

Rate limiting: v3 endpoints allow 60 requests per minute per IP (the token endpoint allows 10 per minute). Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers. When the limit is exceeded the API returns 429; back off until the X-RateLimit-Reset Unix timestamp before retrying.

PowerBI Dashboard Setup

Build a real-time sync monitoring dashboard in PowerBI on top of the v3 API. Because v3 uses OAuth, fetch a token and call the endpoint from a single Power Query (M) script rather than the basic Web connector.

Create a blank query

In PowerBI Desktop, click Get Data > Blank Query, then open the Advanced Editor.

Fetch a token and call the API

Paste the following, substituting your client_id, client_secret, and desired partner:

let
    TokenResponse = Json.Document(Web.Contents(
        "https://api.getkroo.com/api/v3/oauth/token",
        [
            Headers = [#"Content-Type" = "application/x-www-form-urlencoded"],
            Content = Text.ToBinary("grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&scope=read:sync_status")
        ]
    )),
    AccessToken = TokenResponse[access_token],
    Response = Json.Document(Web.Contents(
        "https://api.getkroo.com/api/v3/sync_status?partner=procore&per_page=100",
        [ Headers = [ Authorization = "Bearer " & AccessToken ] ]
    )),
    Data = Response[data],
    ToTable = Table.FromList(Data, Splitter.SplitByNothing(), null, null, ExtraValues.Error),
    Expanded = Table.ExpandRecordColumn(ToTable, "Column1", {"attributes"}, {"attributes"}),
    Attributes = Table.ExpandRecordColumn(Expanded, "attributes",
        {"endpoint_key", "partner_name", "status", "last_updated_at", "next_sync_at",
         "last_sync_status", "last_sync_duration_seconds", "frequency_minutes", "api_calls_last_24h"})
in
    Attributes

Set data types and build visuals

Set Data Types - Date/Time for last_updated_at and next_sync_at, whole number for the numeric columns
Click Close & Apply, then build:
- Status Table - All endpoints with freshness and last-run status
- Freshness Cards - Oldest / newest last_updated_at
- Alert Visuals - Highlight endpoints where last_sync_status is failed or data is stale
- Utilization Charts - api_calls_last_24h by partner

Enable auto-refresh

Publish to PowerBI Service
Go to Settings > Scheduled refresh and set the frequency (hourly recommended)
Configure failure notifications

Access tokens expire after 1 hour. The query above requests a fresh token on every refresh, so scheduled refreshes keep working. For larger integrations, extend the script to loop through meta.total_pages.

Common Use Cases

Monitoring Critical Endpoints

Set up alerts for business-critical data using last_updated_at:

Daily endpoints    → Alert if >25 hours stale
Hourly endpoints   → Alert if >2 hours stale
Frequent endpoints → Alert if >30 minutes stale

Operations Dashboard

Create executive dashboards showing:

Overall data health status (last_sync_status across endpoints)
Sync performance trends (last_sync_duration_seconds)
Integration partner reliability
Partner API utilization (api_calls_last_24h)

Troubleshooting Data Issues

When reports show unexpected data:

Check last_updated_at and last_sync_status to identify sync delays or failures
Compare freshness across related endpoints
Coordinate with Kroo support using specific endpoint_key values and timestamps

Pro Tip: Bookmark your PowerBI dashboard and check it before running important reports to ensure you’re working with fresh data.

Legacy: Pipeline Status API (v1)

The v1 API remains available for existing integrations, but new integrations should use the v3 Sync Status API above. v1 uses Basic Authentication and returns flat maps of pipeline name to timestamp. Find your Basic Auth credentials in the Kroo App under Settings > Company.

Get Available Partners

Endpoint: GET /api/v1/pipeline_status/describe Discover which data integration partners are configured in your Kroo instance.

curl --location 'https://api.getkroo.com/api/v1/pipeline_status/describe' \
--header 'Authorization: Basic [YOUR_CREDENTIALS]'

Response:

{
    "partners": [
        "procore",
        "cmic"
    ]
}

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. Repeat the parameter to include multiple pipelines. If omitted, all pipelines are returned

# All pipelines
curl --location 'https://api.getkroo.com/api/v1/pipeline_status?partner=procore' \
--header 'Authorization: Basic [YOUR_CREDENTIALS]'

# Filtered to specific pipelines
curl --location 'https://api.getkroo.com/api/v1/pipeline_status?partner=procore&filters[]=procore_vendors&filters[]=procore_offices' \
--header 'Authorization: Basic [YOUR_CREDENTIALS]'

Sample Response:

{
    "procore_commitment_change_orders": "2025-09-07T23:02:36.395-07:00",
    "procore_vendors": "2025-09-08T07:02:21.876-07:00",
    "procore_rfis": "2025-09-07T21:03:10.634-07:00",
    "procore_wbs_codes": null
}

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. Accepts the same partner and filters[] parameters as above.

curl --location 'https://api.getkroo.com/api/v1/pipeline_status/next_sync_times?partner=procore' \
--header 'Authorization: Basic [YOUR_CREDENTIALS]'

Sample Response:

{
    "procore_coordination_issues": "2025-12-09T17:00:00.000-08:00",
    "procore_submittals": "2025-12-09T18:00:00.000-08:00",
    "procore_offices": "2025-12-09T18:00:00.000-08:00"
}

Using the App

Analytics

Permissions

Integrations

Pipeline Status Monitoring

Overview

Quick Start

Sync Status API (v3)

List Sync Status

PowerBI Dashboard Setup

Common Use Cases

Monitoring Critical Endpoints

Operations Dashboard

Troubleshooting Data Issues

Legacy: Pipeline Status API (v1)

Get Available Partners

Get Pipeline Status

Get Next Sync Times

​Overview

​Quick Start

​Sync Status API (v3)

​List Sync Status

​PowerBI Dashboard Setup

​Common Use Cases

​Monitoring Critical Endpoints

​Operations Dashboard

​Troubleshooting Data Issues

​Legacy: Pipeline Status API (v1)

​Get Available Partners

​Get Pipeline Status

​Get Next Sync Times

Overview

Quick Start

Sync Status API (v3)

List Sync Status

PowerBI Dashboard Setup

Common Use Cases

Monitoring Critical Endpoints

Operations Dashboard

Troubleshooting Data Issues

Legacy: Pipeline Status API (v1)

Get Available Partners

Get Pipeline Status

Get Next Sync Times