Fremby ProAPI Data Service

/swagger/doc.json

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>.

To get a token your organization needs Fremby Insight. Create the token on the organization's API keys page in the Fremby app, for example https://app.fremby.no/acme/organization/api-keys for the organization acme.

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

Identifiers are opaque strings, passed back unchanged:

  • equipmentProfileID / equipmentID: the id of a fleet row (/bi/v5/fleet) or of a project's equipment (/v1/project/fleet). Both parameter names take the same identifier. It is not the equipmentID field of a fleet row, which is the owner's own label.
  • digitalEquipmentID: the digitalEquipmentID column of /bi/v1/equipment/telemetry.
  • projectID: the id of a project (/v3/projects).
  • locationID: the id column of /bi/v1/location/timeseries/dailysummarizedsnapshot, which has one row per location with data in the range; pass fullRange=true to list every location that has ever had data.
  • workSiteID, shareContractID, shareConnectorID: not listed by any endpoint of this API.

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

Each report is versioned on its own in the path, for example /bi/v5/fleet, /v3/projects and /bi/v6/timeseries/dailysnapshot. Always prefer the highest version available for a given report; lower versions are kept for compatibility and are marked deprecated.

Carbon emissions

carbonEmissionLast24 is the CO₂ emitted that day in kilograms, calculated from the day's consumption: fuel used in liters × 2.62 kg/L plus energy used in kWh × 26 g/kWh. Project reports use the project's own factors when the project has set them.

Errors

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

Fleet

Every equipment that has belonged to the fleet, with its current attributes.

GET
/bi/v1/fleet
Fleet list export (deprecated)
GET
/bi/v1/fleet/snapshot
Fleet snapshot (latest values per equipment)
GET
/bi/v4/fleet
Fleet list export (deprecated)
GET
/bi/v5/fleet
Fleet list export

Telemetry

Raw and per-sample measurement series for individual equipment and metrics.

GET
/bi/v1/digitalEquipment/telemetry
Data source telemetry report
GET
/bi/v1/equipment/telemetry
Equipment telemetry report
GET
/bi/v1/timeseries/cumulativeactiveregenerationhours
Active regeneration hours (cumulative)
GET
/bi/v1/timeseries/cumulativedistance
Distance (cumulative)
GET
/bi/v1/timeseries/cumulativeenergyaccharged
AC energy charged (cumulative)
GET
/bi/v1/timeseries/cumulativeenergycharged
Energy charged (cumulative)
GET
/bi/v1/timeseries/cumulativeenergydccharged
DC energy charged (cumulative)
GET
/bi/v1/timeseries/cumulativeenergyused
Energy used (cumulative)
GET
/bi/v1/timeseries/cumulativefuelused
Fuel used (cumulative)
GET
/bi/v1/timeseries/cumulativeidlehours
Idle hours (cumulative)
GET
/bi/v1/timeseries/cumulativeloadcount
Load count (cumulative)
GET
/bi/v1/timeseries/cumulativenonproductiveidlehours
Non-productive idle hours (cumulative)
GET
/bi/v1/timeseries/cumulativeoperatinghours
Operating hours (cumulative)
GET
/bi/v1/timeseries/cumulativepayloadtotal
Payload totals (cumulative)
GET
/bi/v1/timeseries/cumulativepowertakeoffhours
Power-take-off hours (cumulative)
GET
/bi/v1/timeseries/defremaining
DEF remaining (not yet implemented) (deprecated)
GET
/bi/v1/timeseries/enginecondition
Engine condition (not yet implemented) (deprecated)
GET
/bi/v1/timeseries/faults
Faults (not yet implemented) (deprecated)
GET
/bi/v1/timeseries/fuelremainingratio
Fuel remaining ratio (not yet implemented) (deprecated)
GET
/bi/v1/timeseries/locations
Equipment locations

Daily snapshots

Pre-aggregated daily values (last-24h and cumulative) per equipment, location, project or work site.

GET
/bi/v1/location/timeseries/dailylast24snapshot
Daily last-24h snapshot for a location
GET
/bi/v1/location/timeseries/dailysnapshot
Daily snapshot for a location (deprecated)
GET
/bi/v1/location/timeseries/dailysummarizedsnapshot
Summarized totals per location
GET
/bi/v1/project/timeseries/equipmentdailysnapshot
Daily snapshot for a project's equipment (deprecated)
GET
/bi/v1/projects/timeseries/dailysnapshot
Daily snapshot across projects (deprecated)
GET
/bi/v1/share-contract/timeseries/dailysnapshot
Daily snapshot for a share contract (deprecated)
GET
/bi/v1/timeseries/dailyaverageengineloadfactor
Average engine load factor (daily)
GET
/bi/v1/timeseries/dailyfuelused
Fuel used (daily)
GET
/bi/v1/timeseries/dailypeakspeed
Peak speed (daily)
GET
/bi/v1/timeseries/dailysnapshot
Daily snapshot (active fleet) (deprecated)
GET
/bi/v1/work-site/timeseries/dailysnapshot
Daily snapshot for a work site (deprecated)
GET
/bi/v2/location/timeseries/dailysnapshot
Daily snapshot for a location
GET
/bi/v2/project/timeseries/equipmentdailysnapshot
Daily snapshot for a project's equipment (deprecated)
GET
/bi/v2/projects/timeseries/dailysnapshot
Daily snapshot across projects (deprecated)
GET
/bi/v2/share-contract/timeseries/dailysnapshot
Daily snapshot for a share contract (deprecated)
GET
/bi/v2/timeseries/dailysnapshot
Daily snapshot (active fleet) (deprecated)
GET
/bi/v2/work-site/timeseries/dailysnapshot
Daily snapshot for a work site (deprecated)
GET
/bi/v3/project/timeseries/equipmentdailysnapshot
Daily snapshot for a project's equipment (deprecated)
GET
/bi/v3/projects/timeseries/dailysnapshot
Daily snapshot across projects (deprecated)
GET
/bi/v3/share-contract/timeseries/dailysnapshot
Daily snapshot for a share contract (deprecated)
GET
/bi/v3/timeseries/dailysnapshot
Daily snapshot (active fleet) (deprecated)
GET
/bi/v3/work-site/timeseries/dailysnapshot
Daily snapshot for a work site (deprecated)
GET
/bi/v4/project/timeseries/equipmentdailysnapshot
Daily snapshot for a project's equipment (deprecated)
GET
/bi/v4/projects/timeseries/dailysnapshot
Daily snapshot across projects (deprecated)
GET
/bi/v4/share-contract/timeseries/dailysnapshot
Daily snapshot for a share contract (deprecated)
GET
/bi/v4/timeseries/dailysnapshot
Daily snapshot (active fleet) (deprecated)
GET
/bi/v4/work-site/timeseries/dailysnapshot
Daily snapshot for a work site (deprecated)
GET
/bi/v5/project/timeseries/equipmentdailysnapshot
Daily snapshot for a project's equipment
GET
/bi/v5/projects/timeseries/dailysnapshot
Daily snapshot across projects
GET
/bi/v5/share-contract/timeseries/dailysnapshot
Daily snapshot for a share contract
GET
/bi/v5/timeseries/dailysnapshot
Daily snapshot (active fleet) (deprecated)
GET
/bi/v5/work-site/timeseries/dailysnapshot
Daily snapshot for a work site
GET
/bi/v6/timeseries/dailysnapshot
Daily snapshot (active fleet)

Projects

Project listings and project-scoped equipment reports.

GET
/bi/v1/project/timeseries/equipmentdailysnapshot
Daily snapshot for a project's equipment (deprecated)
GET
/bi/v1/projects/timeseries/dailysnapshot
Daily snapshot across projects (deprecated)
GET
/bi/v2/project/timeseries/equipmentdailysnapshot
Daily snapshot for a project's equipment (deprecated)
GET
/bi/v2/projects/timeseries/dailysnapshot
Daily snapshot across projects (deprecated)
GET
/bi/v3/project/timeseries/equipmentdailysnapshot
Daily snapshot for a project's equipment (deprecated)
GET
/bi/v3/projects/timeseries/dailysnapshot
Daily snapshot across projects (deprecated)
GET
/bi/v4/project/timeseries/equipmentdailysnapshot
Daily snapshot for a project's equipment (deprecated)
GET
/bi/v4/projects/timeseries/dailysnapshot
Daily snapshot across projects (deprecated)
GET
/bi/v5/project/timeseries/equipmentdailysnapshot
Daily snapshot for a project's equipment
GET
/bi/v5/projects/timeseries/dailysnapshot
Daily snapshot across projects
GET
/v1/project/fleet
Equipment in a project
GET
/v1/projects
List organization projects (deprecated)
GET
/v2/projects
List organization projects (deprecated)
GET
/v3/projects
List organization projects

Sharing

Share-contract, work-site and connector reports for shared equipment.

GET
/bi/v1/share-contract/timeseries/dailysnapshot
Daily snapshot for a share contract (deprecated)
GET
/bi/v1/work-site/timeseries/dailysnapshot
Daily snapshot for a work site (deprecated)
GET
/bi/v2/share-contract/timeseries/dailysnapshot
Daily snapshot for a share contract (deprecated)
GET
/bi/v2/work-site/timeseries/dailysnapshot
Daily snapshot for a work site (deprecated)
GET
/bi/v3/share-contract/timeseries/dailysnapshot
Daily snapshot for a share contract (deprecated)
GET
/bi/v3/work-site/timeseries/dailysnapshot
Daily snapshot for a work site (deprecated)
GET
/bi/v4/share-contract/timeseries/dailysnapshot
Daily snapshot for a share contract (deprecated)
GET
/bi/v4/work-site/timeseries/dailysnapshot
Daily snapshot for a work site (deprecated)
GET
/bi/v5/share-contract/timeseries/dailysnapshot
Daily snapshot for a share contract
GET
/bi/v5/work-site/timeseries/dailysnapshot
Daily snapshot for a work site