API: User Status History

M: Listar historial de estados

Límite de Tasa de Peticiones

Máximo de 10 peticiones por IP en 5 minutos

HTTP GET:

https://<hostname>/api/user-status-history

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	si	Hora en formato HH:MM:SS
`end_time`	Hora de fin	Texto	si	Hora en formato HH:MM:SS
`cellphone_ids`	Lista de celulares	Lista de números	no	Listado de ids de celulares para filtrar el historial
`tracker_user_status_ids`	Lista de estados	Lista de números	no	Listado de ids de los estados de los que se quiere el historial

OUTPUT:

Json con los campos:

success: boolean
uomDist: string Unidad de medida de distancia.
data: json Contiene una lista de User Status Record Data Objects

EJEMPLO CON CURL:

$ curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/user-status-history?start_date=2021-01-01&end_date=2021-01-15&start_time=00:00&end_time=23:59&cellphone_ids=2731,5121&tracker_user_status_ids=1340,2138,1021

RESPUESTA:

{
    "success": true,
    "uomDist": "km",
    "data": [
        {
            "start_epoch": 1659605071,
            "end_epoch": 1659608710,
            "status": 2138,
            "start_address": "4ta Avenida, 3ra Calle, Zona 14, Guatemala",
            "end_address": "Central de abastecimiento",
            "start_poi_id": null,
            "end_poi_id": 8512,
            "distance_traveled": 6.11,
            "duration_seconds": 3639,
            "cellphone_id": 2731
        },
        {
            "start_epoch": 1659608710,
            "end_epoch": 1659610232,
            "status": 1340,
            "start_address": "Central de abastecimiento",
            "end_address": "Suministros y Más, S.A.",
            "start_poi_id": 8512,
            "end_poi_id": 1423,
            "distance_traveled": 3.9,
            "duration_seconds": 1522,
            "cellphone_id": 2731
        }
    ]
}

O: User Status Record Data Object

Cada elemento tiene estos campos:

Campo	Descripción
`start_epoch`	Fecha y hora a la que el usuario cambió al estado en formato Unix time.
`end_epoch`	Fecha y hora a la que el usuario cambió a otro estado en formato Unix time.
`status`	Id del estado
`start_address`	Ubicación del usuario cuando cambió al estado.
`end_address`	Ubicación del usuario cuando cambió a otro estado.
`start_poi_id`	Id de la geocerca en la que el usuario cambió al estado; o `null` si no fue en geocerca.
`end_poi_id`	Id de la geocerca en la que el usuario cambió a otro estado; o `null` si no fue en geocerca.
`distance_traveled`	Distancia viajada mientras el usuario estuvo en ese estado.
`duration_seconds`	Cantidad de tiempo en segundos que el usuario estuvo en el estado.
`cellphone_id`	Id del celular.