Reference · built on requestConnectorBuilding management platforms

Clockworks Analytics

Buildings, equipment, points, diagnostics, and task records from the Clockworks Analytics External REST API.

About

Clockworks Analytics is a fault detection and diagnostics platform for HVAC equipment. Its External REST API, published on an Azure API Management developer portal, returns JSON resources for Clients, Buildings, Equipment, Points, Analyses, Diagnostics, Raw Data, VPoints, VData, Task Records, Task Statuses, and Users. GET handles simple retrievals and POST handles filtered ones, such as diagnostics by client, building, equipment, analysis, and date range at HalfDay, Daily, Weekly, or Monthly intervals. Large results page at 1,000 items with a next link.

Through Fibric, an operator reads diagnostics with their avoidable-cost and priority scores, joins them to open tasks, and proposes what to do next for your approval. Each one leaves a receipt: what changed, why, and how to undo it.

This is a reference listing. It documents what Fibric would read from Clockworks Analytics and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Clients, Buildings, Equipment, Equipment Classes and Types, and Points under /core-base
  • Diagnostics by POST /diagnostics with CID, BID, EID, AID, StartDate, EndDate, and AnalysisInterval
  • Diagnostic scores per record: CostSavings in building currency, EnergyPriority, ComfortPriority, and AEID
  • Raw point samples by POST /rawdata with PID and a UTC date range, plus VPoints and VData from analyses
  • Task Records by POST /taskrecords, filtered by Status (Open, In Process, Completed), WorkOrderID, and dates
  • Users with audit data such as login count and last login date

Proposed actions

Read-only. Actions need a separate connector.

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Send the fault with the money attached

    Read daily diagnostics with CostSavings and priority scores, check for an existing Task Record, and propose a work order in your CMMS with the diagnosis attached.

    With Predictive Maintenance, Work Order Aging

  • Close the loop on stale tasks

    Pull Task Records left Open or In Process across the date range, compare against your CMMS, and propose a status update or a reminder.

    With Work Order Aging, Service Interval

  • Rank plants across the portfolio

    Read VData at Daily interval for chiller plant measures such as kW per ton, rank buildings, and propose where to look first.

    With Site Benchmark, Chiller Sequencing

Requirements

  • An API subscriber registration with Clockworks Analytics, which issues the URL endpoint and the subscription key
  • A developer portal sign-in to see API containers, products, and documentation
  • The Client ID (CID) of each subscribing customer you read, since Diagnostics, Raw Data, and VData require it
  • Buildings marked IsActive, which are receiving data and running diagnostics
Authentication
A subscription key from Clockworks Analytics in the Ocp-Apim-Subscription-Key header, with ApiVersion and ApiDocVersion headers and Accept: application/vnd.api+json.

Limits

  • Pages hold up to 1,000 items and each page request regenerates the full dataset, so narrow requests by building and day
  • The documented endpoints retrieve; no create or update endpoint is published, so this listing is read-only
  • Historical records can change: assets deleted, diagnostics purged and re-run, tasks removed, so appending to old pulls is unsafe
  • A task's status at the EndDate cannot be known if it changed later; such tasks come back as Open

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Clockworks Analytics ↗

Questions and answers

What does the Clockworks API return?
JSON with a metadata block carrying ApiVersion, a data array of typed resources with attributes and relationships, and a links object with self, first, next, and last pages. Requests set Accept: application/vnd.api+json and Content-Type: application/json.
How are diagnostics queried?
POST /diagnostics with a single Client ID in CID, StartDate and EndDate in YYYY-MM-DD, and an AnalysisInterval of HalfDay, Daily, Weekly, or Monthly. Optional BID, EID, AID, and ECID arrays narrow the result to buildings, equipment, analyses, or equipment classes.
Can Fibric create tasks in Clockworks?
Not from the published documentation. It lists GET and POST for retrieval and names PUT and PATCH as creating and updating verbs, but publishes no such endpoint. Task creation is proposed in your CMMS instead.
Ask about Clockworks Analytics

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.