Time Series

The following endpoints allow you to retrieve the data history (positions, daily usages, fault codes...) of a single machine.

Activity history

get

/v2/fleet/equipments/{id}/activities

Returns all activities (trips/movements) for a specific piece of equipment.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int64Required

ID of the equipment

Query parameters

sincestring · date-timeOptional

Default is beginning of yesterday UTC

untilstring · date-timeOptional

Default is end of today UTC

Responses

200

Time series of activities for a specific asset

application/json

401

Unable to authenticate the token

application/json

get

/v2/fleet/equipments/{id}/activities

GET /v2/fleet/equipments/{id}/activities HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "data": {
    "total": 1,
    "rows": [
      {
        "dateStart": "2019-11-06T08:00:00Z",
        "dateStop": "2019-11-06T09:30:00Z",
        "distanceMeters": 15420.5,
        "averageSpeedKmH": 12.8,
        "firstPositionAddress": "123 Main St, Springfield, IL",
        "lastPositionAddress": "456 Oak Ave, Springfield, IL"
      }
    ],
    "id": 1,
    "serialNumber": "YVR001988",
    "since": "2019-11-06T00:00:00Z",
    "until": "2019-11-20T23:59:59Z"
  }
}

Fault history

get

/v2/fleet/equipments/{id}/faults

Returns all fault codes for a specific piece of equipment.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int64Required

ID of the equipment

Query parameters

sincestring · date-timeOptional

Default is beginning of yesterday UTC

untilstring · date-timeOptional

Default is end of today UTC

Responses

200

Time series of fault codes for a specific asset

application/json

401

Unable to authenticate the token

application/json

get

/v2/fleet/equipments/{id}/faults

GET /v2/fleet/equipments/{id}/faults HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "data": {
    "total": 2,
    "rows": [
      {
        "date": "2019-11-06T14:30:00Z",
        "description": "Engine coolant temperature too high",
        "identifier": "P0217",
        "severity": 3,
        "levelLabel": "High"
      },
      {
        "date": "2019-11-06T15:45:00Z",
        "description": "Low fuel pressure",
        "identifier": "P0087",
        "severity": 2,
        "levelLabel": "Medium"
      }
    ],
    "id": 1,
    "serialNumber": "YVR001988",
    "since": "2019-11-06T00:00:00Z",
    "until": "2019-11-20T23:59:59Z"
  }
}

Position history

get

/v2/fleet/equipments/{id}/positions

Returns all GPS positions for a specific piece of equipment.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int64Required

ID of the equipment

Query parameters

sincestring · date-timeOptional

Default is beginning of yesterday UTC

untilstring · date-timeOptional

Default is end of today UTC

Responses

200

Time series of positions for a specific asset

application/json

401

Unable to authenticate the token

application/json

get

/v2/fleet/equipments/{id}/positions

GET /v2/fleet/equipments/{id}/positions HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "data": {
    "total": 2,
    "rows": [
      {
        "date": "2019-11-06T14:30:00Z",
        "latitude": 48.844457,
        "longitude": 2.383023,
        "altitude": 35,
        "speed": 25.5,
        "heading": 125.3
      },
      {
        "date": "2019-11-06T14:35:00Z",
        "latitude": 48.846123,
        "longitude": 2.385678,
        "altitude": 38,
        "speed": 32.1,
        "heading": 130.7
      }
    ],
    "id": 1,
    "serialNumber": "YVR001988",
    "since": "2019-11-06T00:00:00Z",
    "until": "2019-11-20T23:59:59Z"
  }
}

Data kind history

get

/v2/fleet/equipments/{id}/{dataKind}

Returns time series data for a specific data kind for a piece of equipment.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int64Required

ID of the equipment

dataKindstring · enumRequired

Data kind identifier.

Example: batteryLevelPossible values:

Query parameters

sincestring · date-timeOptional

Default is beginning of yesterday UTC

untilstring · date-timeOptional

Default is end of today UTC

Responses

200

Snapshot of all devices

application/json

401

Unable to authenticate the token

application/json

get

/v2/fleet/equipments/{id}/{dataKind}

GET /v2/fleet/equipments/{id}/{dataKind} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "data": {
    "total": 1,
    "rows": [
      {
        "percent": 88.24,
        "date": "2025-12-11T01:45:57.468Z"
      }
    ],
    "id": 1,
    "serialNumber": "YVR001988",
    "since": "2019-11-06T00:00:00Z",
    "until": "2019-11-20T23:59:59Z"
  }
}

Daily history

get

/v2/fleet/equipments/{id}/history

Returns comprehensive daily history for a piece of equipment including positions, usage, and fault codes.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int64Required

ID of the equipment

Query parameters

sincestring · date-timeOptional

Default is beginning of yesterday UTC

untilstring · date-timeOptional

Default is end of today UTC

Responses

200

Specific equipment details with its history

application/json

401

Unable to authenticate the token

application/json

get

/v2/fleet/equipments/{id}/history

GET /v2/fleet/equipments/{id}/history HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "name": "D8000-1",
    "make": "Caterpillar",
    "model": "8000",
    "serialNumber": "YVR001988",
    "positions": {
      "total": 1,
      "rows": [
        {
          "latitude": 48.858269,
          "longitude": 2.29447,
          "date": "2025-12-11T01:45:57.468Z"
        }
      ]
    },
    "faultCodes": {
      "total": 1,
      "rows": [
        {
          "levelLabel": "unknown",
          "severity": -1,
          "identifier": "text",
          "description": "text",
          "date": "2025-12-11T01:45:57.468Z"
        }
      ]
    },
    "fuelRemainings": {
      "total": 1,
      "rows": [
        {
          "percent": 88.24,
          "date": "2025-12-11T01:45:57.468Z"
        }
      ]
    },
    "engineConditions": {
      "total": 1,
      "rows": [
        {
          "running": true,
          "date": "2025-12-11T01:45:57.468Z"
        }
      ]
    },
    "dailyUsages": {
      "total": 1,
      "rows": [
        {
          "date": "2025-12-11T01:45:57.468Z",
          "operatingHours": {
            "hour": 8.3
          },
          "idleHours": {
            "hour": 1.5
          },
          "workingHours": {
            "hour": 6.8
          },
          "fuelUsed": {
            "fuelUsed": 99.7,
            "unit": "L"
          },
          "dailyDistance": {
            "odometer": 54.2,
            "unit": "km"
          },
          "cumulativeIdleHours": {
            "hour": 1064.6
          },
          "cumulativeOperatingHours": {
            "hour": 1064.6
          },
          "cumulativeFuelUsed": {
            "fuelUsed": 9520.5,
            "unit": "L"
          },
          "cumulativeDistance": {
            "odometer": 5423.9,
            "unit": "km"
          },
          "cumulativeLoadCount": {
            "count": 13569
          },
          "cumulativePayloadTotal": {
            "payload": 447839.9,
            "payloadUnit": "tonnes"
          },
          "cumulativeActiveRegenerationHours": {
            "hour": 10.92
          },
          "cumulativePowerTakeOffHours": {
            "hour": 31.21
          },
          "peakDailySpeed": {
            "speed": 14.91,
            "speedUnit": "km/h"
          },
          "averageDailyEngineLoadFactor": {
            "percent": 35.9
          },
          "DEFRemainingRatio": {
            "percent": 62,
            "tankCapacity": 41,
            "tankCapacityUnit": "L"
          },
          "co2": {
            "weight": 123,
            "unit": "kg"
          }
        }
      ]
    }
  }
}

Deprecated

Fleet

get

/v2/fleet/equipments/history

⚠️ This endpoint will be deprecated and should not be used anymore. Returns the list of all equipments and their history (positions, daily usages, fault codes). This endpoint is paginated.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Query parameters

sincestring · date-timeOptional

Default is beginning of yesterday UTC

untilstring · date-timeOptional

Default is end of today UTC

limitinteger · int64 · max: 50Optional

The numbers of items to return

Default: 20

offsetinteger · int64Optional

The number of items to skip before starting to collect the result set

Default: 0

Responses

200

List of equipment with their history

application/json

401

Unable to authenticate the token

application/json

get

/v2/fleet/equipments/history

GET /v2/fleet/equipments/history HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "data": {
    "total": 1,
    "since": "2019-11-06T00:00:00Z",
    "until": "2019-11-20T23:59:59Z",
    "rows": [
      {
        "id": 1,
        "name": "D8000-1",
        "make": "Caterpillar",
        "model": "8000",
        "serialNumber": "YVR001988",
        "positions": {
          "total": 1,
          "rows": [
            {
              "latitude": 48.858269,
              "longitude": 2.29447,
              "date": "2025-12-11T01:45:57.468Z"
            }
          ]
        },
        "faultCodes": {
          "total": 1,
          "rows": [
            {
              "severity": -1,
              "identifier": "text",
              "description": "text",
              "date": "2025-12-11T01:45:57.468Z"
            }
          ]
        },
        "fuelRemainings": {
          "total": 1,
          "rows": [
            {
              "percent": 88.24,
              "date": "2025-12-11T01:45:57.468Z"
            }
          ]
        },
        "engineConditions": {
          "total": 1,
          "rows": [
            {
              "running": true,
              "date": "2025-12-11T01:45:57.468Z"
            }
          ]
        },
        "dailyUsages": {
          "total": 1,
          "rows": [
            {
              "date": "2025-12-11T01:45:57.468Z",
              "operatingHours": {
                "hour": 8.3
              },
              "idleHours": {
                "hour": 1.5
              },
              "workingHours": {
                "hour": 6.8
              },
              "fuelUsed": {
                "fuelUsed": 99.7,
                "unit": "L"
              },
              "dailyDistance": {
                "odometer": 54.2,
                "unit": "km"
              },
              "cumulativeIdleHours": {
                "hour": 1064.6
              },
              "cumulativeOperatingHours": {
                "hour": 1064.6
              },
              "cumulativeFuelUsed": {
                "fuelUsed": 9520.5,
                "unit": "L"
              },
              "cumulativeDistance": {
                "odometer": 5423.9,
                "unit": "km"
              },
              "cumulativeLoadCount": {
                "count": 13569
              },
              "cumulativePayloadTotal": {
                "payload": 447839.9,
                "payloadUnit": "tonnes"
              },
              "cumulativeActiveRegenerationHours": {
                "hour": 10.92
              },
              "cumulativePowerTakeOffHours": {
                "hour": 31.21
              },
              "peakDailySpeed": {
                "speed": 14.91,
                "speedUnit": "km/h"
              },
              "averageDailyEngineLoadFactor": {
                "percent": 35.9
              },
              "DEFRemainingRatio": {
                "percent": 62,
                "tankCapacity": 41,
                "tankCapacityUnit": "L"
              }
            }
          ]
        }
      }
    ]
  }
}

PreviousSnapshot NextFleet Identity

Last updated 1 day ago

Was this helpful?