How to get familiar with the API

We know that the API could be complex to understand during the initial steps, in order to progress in your API knowledge and maturity, we propose you that to follow multiple path

Export module from activity

The most easiest way to understand how API calls are constructed, our recommendation is to craft a query via the Activity>Export module

By following the steps, you will be able to tell exactly what you need.

Step 1 : define your metrics

Step 2 : define your aggregations

Step 3: Get the curl command to understand the query payload

The most important part is the query payload and JSON structure to get what you need

{"subfleet":{"providers":[],"device_types":[],"hours_of_day":[],"start_time":"2023-01-14T23:00:00.000Z","end_time":"2023-01-21T23:00:00.000Z","geo_fences":[{"tags":["Level 10 Central Zone"]}]},"resolution":"hour","groupings":[{"grouping":"no_grouping"}],"metric_types":["fleet_size"]

Use the recipe

An other way to learn more by use case is to follow our Recipe

Its a list of simple "How to" based on the most common use case and needs. If you would like see knew ones, don't hesitate to contact us directly.

Advance usage

More the most advance users, we also provide some article on how to apply machine learning to detect clusters of devices by combining the power of the Vianova API with python noteboks.

Please refer to our Medium article