# Clockworks Analytics

> Clockworks Analytics is a building-analytics company whose cloud platform performs automated fault detection and diagnostics (FDD) on HVAC and building systems. It ingests interval data from Building Management Systems through the Clockworks Connect gateway, runs a curated library of root-cause diagnostics, and quantifies each performance issue by avoidable energy cost and by energy, comfort and maintenance priority on a 0-10 scale. Its REST API is delivered through Azure API Management on rest.buildingsapi.net in four containers.

This file was generated by API Evangelist from Clockworks Analytics' own public documentation. Clockworks does not publish an llms.txt of its own, and publishes no OpenAPI, AsyncAPI, GraphQL SDL or Postman collection — the API reference is HTML only.

## APIs

- [Clockworks Base API](https://rest.buildingsapi.net/core-base): Clients, buildings, building types and variables, equipment, equipment classes/types/variables, points, point classes/types, engineering units, data sources, analyses, task records, task statuses and users. JSON:API-shaped responses. Authenticated with an Azure API Management subscription key in the `Ocp-Apim-Subscription-Key` header.
- [Clockworks Diagnostics API](https://rest.buildingsapi.net/core-diag): `POST /diagnostics` returns diagnostic records for a set of client IDs, building IDs, a date range and an analysis interval, including avoidable cost, energy/comfort/maintenance priorities and narrative fault notes.
- [Clockworks Key Performance Indicators API](https://rest.buildingsapi.net/core-kpis): `POST /AggregatedData` accepts a Kusto Query Language (KQL) expression plus a dataset list and returns server-side aggregations across the Clockworks datasets.
- [Clockworks Work Orders API](https://rest.buildingsapi.net/workorders): Task records created from diagnostic results, for synchronization to a CMMS. Bearer token from `POST /workorders/auth/token` using a clientId and clientSecret; the token is valid for 3599 seconds.

## Docs

- [API Documentation](https://cw.clockworksanalytics.com/APIDocumentation.aspx): the full public REST reference — resources, request/response keys, sample requests and responses.
- [Developer Portal](https://clockworks.developer.azure-api.net/): Azure API Management developer portal. The API and product lists are empty to anonymous callers; sign-in is required.
- [CMMS Integration Developer Guide (version 2)](https://clockworksanalytics.atlassian.net/wiki/spaces/ClockworksAnalyticsUM/pages/5742297089/CMMS+Integration+Developer+Guide+version+2): end-to-end integration walkthrough including both authentication models.
- [Key Performance Indicators API Developer Guide](https://clockworksanalytics.atlassian.net/wiki/spaces/ClockworksAnalyticsUM/pages/4577951781/Key+Performance+Indicators+API+Developer+Guide): the KQL query contract and the full dataset catalog.
- [Task V2 API Endpoint Migration](https://clockworksanalytics.atlassian.net/wiki/spaces/ClockworksAnalyticsUM/pages/5390794755/Task+V2+API+Endpoint+Migration): breaking changes between the Task V1 and Task V2 responses.
- [User Manual](https://clockworksanalytics.atlassian.net/wiki/spaces/ClockworksAnalyticsUM/overview)

## Conventions

- Media types: request `application/json`, response `application/vnd.api+json`.
- Versioning is by HTTP header (`ApiVersion`, `ApiDocVersion`), not by URL path.
- Pagination is page-number based at a fixed 1,000 elements per page via `page[number]`, with `self`/`first`/`next`/`last` links carrying a server-side cache key so a traversal returns a stable snapshot.
- Sparse fieldsets via `fields[<ResourceType>]`, chainable across related resources.
- Verbs: GET simple retrievals, POST complex retrievals, PUT create, PATCH update, OPTIONS preflight.
- No idempotency contract, no published rate limits, no error-code reference, no webhooks or event surface.

## Company

- [Website](https://clockworksanalytics.com/)
- [Blog](https://clockworksanalytics.com/blog/)
- [Product Updates](https://clockworksanalytics.com/product-updates/)
- [Status](https://status.clockworksanalytics.com/)
- [Trust Center](https://trust.clockworksanalytics.com/)
- [Support](https://kgsbuildings.atlassian.net/servicedesk/customer/portals)
- [Login](https://portal.clockworksanalytics.com/login)
- [Website Terms of Use and Privacy Policy](https://clockworksanalytics.com/website-terms-of-use/)

## API Evangelist artifacts

- [apis.yml](https://raw.githubusercontent.com/api-evangelist/clockworks-analytics/refs/heads/main/apis.yml)
- [Authentication](https://raw.githubusercontent.com/api-evangelist/clockworks-analytics/refs/heads/main/authentication/clockworks-analytics-authentication.yml)
- [Conventions](https://raw.githubusercontent.com/api-evangelist/clockworks-analytics/refs/heads/main/conventions/clockworks-analytics-conventions.yml)
- [Data Model](https://raw.githubusercontent.com/api-evangelist/clockworks-analytics/refs/heads/main/data-model/clockworks-analytics-data-model.yml)
- [Lifecycle](https://raw.githubusercontent.com/api-evangelist/clockworks-analytics/refs/heads/main/lifecycle/clockworks-analytics-lifecycle.yml)
- [Changelog](https://raw.githubusercontent.com/api-evangelist/clockworks-analytics/refs/heads/main/changelog/clockworks-analytics-changelog.yml)
- [Conformance](https://raw.githubusercontent.com/api-evangelist/clockworks-analytics/refs/heads/main/conformance/clockworks-analytics-conformance.yml)
- [Sandbox](https://raw.githubusercontent.com/api-evangelist/clockworks-analytics/refs/heads/main/sandbox/clockworks-analytics-sandbox.yml)
- [Domain Security](https://raw.githubusercontent.com/api-evangelist/clockworks-analytics/refs/heads/main/security/clockworks-analytics-domain-security.yml)
- [Trust Center](https://raw.githubusercontent.com/api-evangelist/clockworks-analytics/refs/heads/main/security/clockworks-analytics-trust-center.yml)