Fremby ProAPI Data Service

The Fremby ProAPI gives you programmatic, read-only access to your fleet's telemetry and daily aggregates — the same data that powers Fremby dashboards and the Microsoft Power BI / Power Flow integrations.

Response formats

Endpoints return JSON or CSV. Where an endpoint supports more than one format, select it with the Accept header:

• Accept: application/json → a JSON array of records.
• Accept: application/stream+json → the same records as a newline-delimited JSON stream, friendlier for very large fleets.
• Accept: text/csv → a CSV download whose first row is the column header.

Not every endpoint offers every format: some are JSON-only (e.g. the project listings) and some are CSV-only (e.g. raw equipment telemetry). For endpoints that support CSV, a request with no Accept header returns CSV.

Authentication

All endpoints require a JWT Bearer token: Authorization: Bearer <token>. Tokens are issued per organization. If you authenticate with a personal token that spans more than one organization, also pass the orgID query parameter to select which organization to read. With an organization-scoped token, orgID is not needed.

Identifiers

Object identifiers (equipmentProfileID, projectID, locationID, shareContractID, …) are read from API responses and passed back unchanged.

Dates, ranges and time zones

All timestamps are UTC, formatted as RFC 3339 / ISO 8601. Reports accept a rangeStart and rangeEnd (both inclusive); when omitted, default to the last 7 days (project/fleet listings to all history). Pass fullRange=true to ignore the range and return the entire available history.

Versioning

Endpoints are versioned in the path (/bi/v1/… … /bi/v6/…). Always prefer the highest version available for a given report; lower versions are kept for compatibility and are marked deprecated.

Errors

A failed request returns the matching 4xx/5xx status with an RFC 7807 problem body (application/problem+json): {"type": …, "title": …, "status": …, "detail": …}.