Metrics

post

https://api.vianova.dev/zones/{zone_id}/metrics/

Get metrics on feeds, regulations & infringements, fleet of vehicles

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

zone_id

integer

required

Query Params

skip_cache

boolean

Defaults to false

reprocess_cache

boolean

Defaults to false

Body Params

Payload to get all the metrics based on multiple fields on specific groupings.

It reuses the concept of a Subfleet to filter the output metrics on many params.

Restrictions :

Some metrics are incompatible together. We have 3 types of metrics :
- feed. Metrics :
  - feed_status
- regulation. Metrics :
  - count_infringement
  - count_infringement_unique
  - infringement_duration_hours
  - compliance
  - amount_fees_subsidies
  - regulation_metric_value
- fleet. Metrics :
  - availability
  - co2_savings
  - count_destination
  - count_origin
  - count_riding
  - distance_destination
  - distance_origin
  - duration_destination
  - duration_origin
  - fleet_size
  - idle_time_seconds
  - vehicle_rotation
You can't ask for metrics in one request if they're not in the same group.
For example :
- you can ask for availability + fleet_size, they're in the fleet metrics group.
- you can NOT ask for availability + count_infringement, one is about fleet and the other one is about regulations
Some metrics can only be grouped by some groupings :

metric	day_of_week	device_type	feed	geo_fence	h3	hour_of_day	no_grouping	provider	regulation	regulation_type
amount_fees_subsidies	X	X				X	X	X	X	X
availability	X	X		X	X	X	X	X
co2_savings	X	X		X	X	X	X	X
compliance	X	X				X	X	X	X	X
count_destination	X	X		X	X	X	X	X
count_infringement	X	X				X	X	X	X	X
count_infringement_unique	X	X				X	X	X	X	X
count_origin	X	X		X	X	X	X	X
count_riding	X	X		X	X	X	X	X
distance_destination	X	X		X	X	X	X	X
distance_origin	X	X		X	X	X	X	X
duration_destination	X	X		X	X	X	X	X
duration_origin	X	X		X	X	X	X	X
feed_status			X				X	X
fleet_size	X	X		X	X	X	X	X
idle_time_seconds	X	X		X	X	X	X	X
infringement_duration_hours	X	X				X	X	X	X	X
regulation_metric_value	X	X				X	X	X	X	X
vehicle_rotation	X	X		X	X	X	X	X

subfleet

object

A subfleet acts as a query-filter to select a subset of the total events related to a fleet.
You can filter on many parameters :

geofeatures (where)
datetimes (when)
devices definition (what)
- providers
- types
- states
trips
)
...

WARNING : If regulations is set, the endpoint will return all regulation related events.

groupings

array of objects

Defaults to []

Groupings

metric_types

array of objects

Defaults to []

metric_types

window

ResolutionInterval | number

deprecated

resolution

ResolutionInterval | number

Defaults to hour

The resolution of the metrics

aggregation_type

string

enum

Defaults to average

An enumeration.

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Payload to get all the metrics based on multiple fields on specific groupings.

200Successful Response

422Validation Error