Aller au contenu

Mesure

Ce qu'on tire de l'exploitation une fois le service assuré : les distances, la régularité, la fréquentation, et la trace conservée de tout cela.

trip-km

Kilomètres parcourus — la distance réalisée, ventilée par course, par véhicule ou par période. Sert à la facturation au kilomètre, au suivi contractuel et au dimensionnement du parc.

Pas d'identifiant propre : la donnée s'obtient par période et par périmètre.

Endpoint Rôle
GET /api/v4/groups/<group_id>/stats/trip-km Agrège les kilomètres sur une période
GET /api/v4/groups/<group_id>/export/trip-km Exporte le détail au format CSV

Les kilomètres à vide, parcourus hors course commerciale, sont portés par le service de conduite — voir duties.

punctuality

Ponctualité — la mesure de l'écart entre l'horaire prévu et l'heure de passage réelle, agrégée sur une période. C'est l'indicateur de qualité de service le plus suivi par les autorités organisatrices.

Pas d'identifiant propre : la donnée s'obtient par période et par périmètre.

Endpoint Rôle
GET /api/v4/groups/<group_id>/stats/punctuality Agrège la ponctualité sur une période
GET /api/v4/groups/<group_id>/export/punctuality Exporte le détail au format CSV

La mesure s'appuie sur les horaires théoriques — voir stop_times — et sur les passages observés.

passenger-counts

Comptage voyageurs — le nombre de montées et de descentes relevé aux arrêts, par course. Il provient des systèmes de comptage embarqués, et alimente le dimensionnement de l'offre.

Pas d'identifiant propre : la donnée s'obtient par période et par périmètre.

Endpoint Rôle
GET /api/v4/groups/<group_id>/stats/passenger-counts Agrège la fréquentation sur une période
GET /api/v4/groups/<group_id>/export/passenger-counts Exporte le détail au format CSV

stats

Statistiques — la famille transverse des endpoints d'agrégation et d'export. Ce n'est pas une entité au sens des autres entrées : le tag rassemble les restitutions calculées sur les entités précédentes, sous deux formes constantes — un agrégat sous /stats/, un export CSV sous /export/.

Endpoint Rôle
GET /api/v4/groups/<group_id>/stats/vehicles-used Compte les véhicules engagés sur une période
GET /api/v4/groups/<group_id>/stats/daily_devices Compte les appareils actifs par jour
GET /api/v4/groups/<group_id>/vehicle-amount Donne le nombre de véhicules du groupe

Les huit exports CSV du spec datahub — courses, conducteurs, véhicules, alertes, ponctualité, kilomètres, suivi de course, comptage voyageurs — constituent la voie recommandée pour alimenter un entrepôt de données. Ils sont décrits dans les exemples de collecte.

history

Historique — la conservation de ce qui s'est produit, au-delà de la fenêtre temps réel : événements remontés par les appareils, horaires observés aux arrêts, GTFS en vigueur aux dates concernées, kilomètres relevés. C'est la source à interroger pour reconstituer une journée passée.

Pas d'identifiant propre : l'historique s'interroge par périmètre et par période.

Endpoint Rôle
GET /api/v4/groups/<group_id>/history/events Liste les événements remontés par les appareils
GET /api/v4/groups/<group_id>/history/stop_times Donne les passages observés aux arrêts
GET /api/v4/groups/<group_id>/history/gtfs-active Donne le GTFS en vigueur à une date
GET /api/v4/groups/<group_id>/devices/<device_id>/history Retrace l'activité d'un appareil

Les horaires observés conservés ici sont à distinguer des horaires prévus, qui appartiennent au référentiel théorique — voir stop_times.