API: Eventos

M: Listar Eventos

Límite de Tasa de Peticiones

Máximo de 10 peticiones por IP en 5 minutos

HTTP GET:

https://<hostname>/api/events

URL PARAMETERS:

	Nombre	Tipo	Requerido	Descripción
`start_date`	Fecha de inicio	Texto	si	Fecha en formato YYYY-MM-DD
`end_date`	Fecha de fin	Texto	si	Fecha en formato YYYY-MM-DD
`start_time`	Hora de inicio	Texto	no	Hora en formato HH:MM, valor por defecto: "00:00"
`end_time`	Hora de fin	Texto	no	Hora en formato HH:MM, valor por defecto: "23:59"
`start_of_day`	Inicio del día	Texto	no	Hora en formato HH:MM, valor por defecto: "00:00"
`end_of_day`	Fin del día	Texto	no	Hora en formato HH:MM, valor por defecto: "23:59"
`findBy`	Filtrar por	Texto	no	Determina si utilizará `vehicle_ids` o `driver_ids` (por defecto `vehicle_ids`), valores válidos: `veh`, `driver`
`reason_ids`	IDs de razones	Lista de números	no	Filtrar por IDs de la razón que generó al evento, separado por comas
`vehicle_ids`	IDs de vehículos	Lista de números	no	Filtrar por IDs de vehículos, `findBy` debe ser igual a `veh`, separado por comas
`driver_ids`	IDs de conductores	Lista de números	no	Filtrar por IDs de conductores, `findBy` debe ser igual a `driver`, separado por comas
`days_of_week`	Días de la semana	Lista de números	no	Filtrar por días de la semana (0-6)
`pois`	IDs de geocercas	Lista de números	no	Filtrar por ID de Geocercas
`min_duration`	Duración mínima (en segundos) de visita a geocerca	Numérico	no	Filtrar el tiempo mínimo que se visitó una geocerca.

OUTPUT:

Json con los campos:

timezone: Zona horaria del reporte
data: Lista de objetos de eventos

EJEMPLO CON CURL:

$ curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/events?start_date=2024-12-10&end_date=2024-12-10&vehicle_ids=1007,1008

RESPUESTA:

{
    "timezone": "America/Guatemala",
    "data": [
        {
            "vehicle_id": 1007,
            "driver": null,
            "trip_id": 305631,
            "point_id": 9239430,
            "datetime_iso": "2024-12-10T07:00:24-06:00",
            "placename": "Guatemala",
            "poi_id": 176480,
            "reason": {
                "id": 16384,
                "label": "excedió límite vel. (de geocerca:  40 km\/h, vel.:  80 km\/h)"
            }
        }
    ]
}

O: Objeto de Evento

Cada elemento tiene estos campos:

Campo	Descripción
`vehicle_id`	Identificador del vehículo
`driver`	Información del conductor (puede ser null)
`trip_id`	Identificador del viaje
`point_id`	Identificador del punto del evento
`datetime_iso`	Fecha y hora del evento en formato ISO 8601 con zona horaria
`placename`	Nombre del lugar donde ocurrió el evento
`poi_id`	Identificador del Punto de Interés relacionado
`reason`	Objeto con detalles de la razón del evento
`reason.id`	ID de la razón del evento
`reason.label`	Descripción del evento
`location`	Objeto que contiene las coordenadas del evento
`location.lat`	Latitud de la ubicación del evento
`location.lon`	Longitud de la ubicación del evento
`extras`	Información adicional del evento (puede ser null)
`photo_id`	Identificador de la foto asociada al evento (puede ser null)
`signature_photo_id`	Identificador de la foto de firma asociada al evento (puede ser null)
`duration_seconds`	Duración del evento en segundos