API: Resumen Diario

M: Consultar

HTTP GET:

https://<hostname>/api/vehicles/stats

PARÁMETROS DE URL:

Key Name Type Required Description
start_date Start Date String yes Start date for fetching data in "YYYY-MM-DD" format.
end_date End Date String yes End date for fetching data in "YYYY-MM-DD" format.
vehicles Vehicle Ids List of Int no A list of comma-separated vehicle or group ids. Group ids must include the prefix "g-"

OUTPUT:

Json con los campos:

El campo data contiene un Json para cada día consultado que tenga información válida. e.g. Si ningún vehículo consultado genera información durante uno de los días consultados, ese día no se enviará en la respuesta.

EJEMPLO CON CURL:

curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/vehicles/stats?vehicles=244,245,g-136,g-137&start_date=2017-05-10&end_date=2017-05-24

RESPUESTA:

{
    "success": true,
    "data": {
        "2017-05-10": {
            "total_distance": "543.49",
            "moving_time": "9973",
            "stopped_time": "46080",
            "notification_count": "52",
            "ign_on_time": "15348"
        },
        "2017-05-15": {
            "total_distance": "134.27",
            "moving_time": "5334",
            "stopped_time": "745",
            "notification_count": "21",
            "ign_on_time": "9312"
        }
    }
}

O: Daily Stats Object

Key Nombre Tipo Unidades Descripción
total_distance Distancia Total Double (2 decimales) Km Sumatoria de la distancia recorrida por los vehículos consultados.
moving_time Tiempo en Movimiento Integer Segundos Sumatoria del tiempo en movimiento de los vehículos consultados.
stopped_time Tiempo detenido Integer Segundos Sumatoria del tiempo detenido de los vehículos consultados. Este dato es independiente del ignición.
notification_count Cantidad de Notificaciones Integer Cantidad de notificaciones generadas por los vehículos consultados.
ign_on_time Tiempo con ignición encendida Integer Segundos Sumatoria del tiempo con ignición encendida de los vehículos consultados.

M: Resumen por vehículo

HTTP GET:

https://<hostname>/api/vehicle/vehicle_id/stats

PARÁMETROS DE URL:

Key Name Type Required Description
vehicle_id Vehicle Id String yes Vehicle id or any to list all vehicles
start_date Start Date String yes Start date for fetching data in "YYYY-MM-DD" format.
end_date End Date String yes End date for fetching data in "YYYY-MM-DD" format.

OUTPUT:

Json con los campos:

El campo data contiene un Json con el resumen y detalle del resumen diaro. Si el campo any se utiliza como parámetro, se listarán todos los vehículos con su respectivo id.

EJEMPLO CON CURL:

curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/vehicle/195/stats?start_date=2017-05-10&end_date=2017-05-24

RESPUESTA:

{
  "success": true,
  "data": {
    "summary": {
      "speed_units": "mph",
      "distance_units": "mi",
      "volume_units": "Galones",
      "ign_on_hrs": 165.6,
      "distance": 706,
      "moving_secs": 7265,
      "max_speed": 6.21,
      "trips": 3,
      "idle_days": 5,
      "rules_broken_cnt": 0,
      "fuel_consumed": 46.5,
      "estimated_fuel_consumed_by_distance": 5.8,
      "estimated_fuel_consumed_by_ign_on_hrs": 39.6
    },
    "detail": [
      {
        "driver_id": null,
        "stat_date": "2018-11-15",
        "moving_secs": "2851",
        "stopped_time": "83549",
        "fuel_consumed": "0.00",
        "trips_cnt": "1",
        "stops_cnt": "14",
        "first_ign_on": "1542294488",
        "last_ign_off": "1542301649",
        "ign_on_hrs": "100.8000",
        "rules_broken_cnt": "0",
        "init_ign_on_hrs": "584186.4000",
        "estimated_fuel_consumed_by_distance": "0",
        "estimated_fuel_consumed_by_ign_on_hrs": "0",
        "idle_day": "0",
        "max_speed": 6.21,
        "total_distance": 380.93,
        "init_odometer": 3143.29
      }
    ]
  }
}

O: Stat Summary Object

Key Nombre Tipo Descripción
speed_units Unidad velocidad String Unidad de velocidad del cliente
distance_units Unidad de distancia String Unidad de distancia del cliente
volume_units Unidad de volumen String Unidad de volumen del cliente
ign_on_hrs Tiempo con ignición encendida Double (1 decimal) Sumatoria del tiempo con ignición encendida del vehículo
distance Distancia recorrida Double (2 decimales) Sumatoria de la distancia recorrida del vehículo
moving_secs Tiempo de movimiento en segundos Integer Sumatoria del tiempo en movimiento
max_speed Velocidad màxima Double (2 decimales) Máxima velocidad del vehículo
trips Cantidad de viajes Integer Sumatoria de los viajes realizados por el vehículo
idle_days Días ociosos Integer Sumatoria de los días ociosos
rules_broken_cnt Total de reglas rotas Integer Sumatoria de las reglas rotas
fuel_consumed Combustible consumido Double (2 decimales) Total de combustible consumido
estimated_fuel_consumed_by_distance Estimado de consumo de combustible por distancia Dobule (1 decimal) Consumo estimado basado en distancia recorrida
estimated_fuel_consumed_by_ign_on_hrs Estimado de consumo de combustible por ignición encendida Double (1 decimal) Estimado de consumo de combustible por ignición encendida

O: Stat Detail Object

Key Nombre Tipo Descripción
driver_id Id de conductor Integer Id del conductor
stat_date Fecha del estado String Fecha del estado
moving_secs Tiempo de movimiento Integer Tiempo en movimiento del vehículo en segundos
stopped_time Tiempo detenido Integer Tiempo detenido del vehículo en segundos
fuel_consumed Consumo de combustible Double (2 decimales) Consumo de combustible durante el viaje
trips_cnt Conteo de viajes Integer Total de viajes
stops_cnt Conteo de paradas Integer Total de paradas
first_ign_on Primer encedido de ignición Fecha y hora Primer encedido de ignición
last_ign_off Último apagado de ignición Fecha y hora Último apagado de ignición
ign_on_hrs Ignición encendida en horas Double (4 decimales) Total de tiempo en horas con ignición encendida
rules_broken_cnt Conteo de reglas rotas Integer Cantidad de reglas rotas
init_ign_on_hrs Combustible consumido Double (2 decimales) Total de combustible consumido
estimated_fuel_consumed_by_distance Estimado de consumo de combustible por distancia Dobule (2 decimal) Consumo estimado de combustible basado en distancia recorrida
estimated_fuel_consumed_by_ign_on_hrs Estimado de consumo de combustible por ignición encendida Double (2 decimales) Estimado de consumo de combustible basado en tiempo de ignición encendida
idle_day Día ocioso Integer 0 si el vehículo estuvo oscioso o 1 en caso contrario
max_speed Velocidad máxima Double (1 decimales) Máxima velocidad registrada en el viaje
total_distance Distancia total Double (2 decimales) Distancia total recorrida en el viaje
init_odometer Odómetro al inicio Double (2 decimales) Odómetro al inicio del viaje