FAQ & Troubleshooting

General

I got an error, what should I do?

Don't hesitate to contact us you can refer to our support page for the process.

Is there any rate-limit?

No, at this time we do not enforce a rate-limit, but the data will change at most once every 10min. If we encounter any issues or abuse, we may contact you to discuss your specific needs.

Do you have a Postman collection?

Yes, you find all the details in our documentation here.

Authentication

How to get access?

If you have an account on production, you will be able to generate credentials on the Destinations Page in the Hiboo application.

If you have no access to this page, contact us at [email protected]

Does the authentication token expire?

• Yes, at the moment it is set to expires after 10 days

Data freshness

What is the frequency of the data ?

• The amount of data given can vary for a single endpoint depending on the source of the data. One value per day at maximum can be provided for all daily variables (dailyFuel, dailyDistance...). Multiple values per day can be provided for all other variables (cumulativeOperatingHours, positions, cumulativeDistances...)

• Some constructors provide only one cumulative value per day, others can provide up to one value per minute

• In our sandbox environment there are less data today. You can expect one data point per day. All data points are not handled too, for instance CumulativePowerTakeOff is not yet available.

What time range can I request ?

• For endpoints where dates can be provided as parameters (such as /equipments/{id}/history), the maximum possible value is a 14 (fourteen) days period whenever in the past.

Can data be updated over time, for instance daily data? Does it happen on a fixed schedule?

We compute data in near real-time when we receive data. So depending on the data source, it does not happen on a schedule.

For instance for a given brand of equipment, we receive data of "Engine off" only when the engine of the machine is turned back on so there can be a delay of a few days, sometime more.

With this in mind, an update after 2-3 days is quite typical especially because of the weekend.

Today, we recommend to:

• Fetch recent data multiple times per day or per hour depending on the use case (either using the snapshot endpoint or a small time span)

• Fetch 10 days of data every week in order to catch up any changes

Data understanding

There’s daily data but what about timezone?

Great question, when we compute daily data (operatingHours, idleHours, fuelUsed...) the timezone of the equipment is taken into consideration.

So if you fetch data for 2022-04-20T00:00:00Z, we should actually only provide 2022-04-20 as the time we consider depends on the geolocation of the equipment.

For instance, if an equipment is on the America/Pacific timezone, we would consider activity between 2022-04-20T07:00:00Z and 2022-04-21T06:59:59Z

Pagination

Why are you using paginated endpoints?

A paginated endpoint is an endpoint that returns a subset of the data, we are doing so for:

• Better Performance – Prevents retrieving too much data at once.

• Improved API Efficiency – Reduces load on the server.

• Easier Navigation – Fetch data in smaller, manageable chunks.

How to use paginated endpoints?

To get the entire dataset, you need to make multiple requests to the endpoint, each time retrieving a different subset of the data. To do so, you need to use the limit and offset query parameters :

limit: it controls the numbers of items returned offset: it controls the number of items to skip before starting to collect the result set