Consulta de medidores

Mediante esta API se consulta el listado de los medidores creados en Fracttal. Permite filtrar para obtener solo los medidores que necesitas: por el código del activo, por el serial del medidor o por una ubicación.

  • Para obtener los medidores que pertenecen a un activo específico, envía el parámetro code (código del activo).
  • Para obtener la información de un medidor en específico, envía los parámetros code (código del activo) y serial (serial del medidor).
  • Para obtener los medidores de los activos vinculados a una ubicación y a sus ubicaciones secundarias (hijas), envía el parámetro location_code.

Add-on

Uso general — sin add-on específico.

GET https://app.fracttal.com/api/meters

Parámetros de entrada

ParámetroTipoRequeridoDescripción
codetextoOpcionalCódigo del activo que tiene asociado el medidor.
serialtextoOpcionalSerial del medidor que se desea consultar.
startenteroOpcionalCampo que sirve para hacer la paginación de registros. Es el número en el que comienza la paginación. Por defecto es 0.
limitenteroOpcionalCantidad de registros (items) que se desea que el API devuelva. Por defecto es 100 (no puede ser superior a este valor).
location_codetextoOpcionalCódigo de la localización principal (ubicación padre) para consultar los medidores vinculados a sus ubicaciones secundarias (hijas).

Parámetros de salida

ParámetroTipoDescripción
identeroIdentificador del medidor.
activebooleanoIndica el estado del medidor, permitiendo identificar si se encuentra habilitado o no.
descriptiontextoDescripción del medidor.
serialtextoSerial del medidor.
is_counterbooleanoIndica si el medidor es de tipo contador (acumulador).
counter_offset_valuenúmeroValor base del contador. Es el valor sobre el cual se suman las lecturas para obtener el acumulado; por ejemplo, se actualiza cuando el contador se reinicia. No es el valor acumulado.
counter_valuenúmeroValor acumulado actual del contador (valor base más las lecturas registradas).
last_dataobjetoInformación de la última lectura agregada al medidor. Ver estructura en la tabla siguiente.
monthly_average_datanúmeroValor promedio mensual.
units_descriptiontextoDescripción de la unidad del medidor.
units_codetextoCódigo de la unidad del medidor.
items_descriptiontextoDescripción del activo al cual pertenece el medidor.
parent_descriptiontextoLocalización a la cual pertenece el activo.
monthly_average_autobooleanoIndica si el promedio mensual será calculado por el sistema o lo ingresará manualmente el usuario.
min_valuenúmeroValor mínimo del medidor.
max_valuenúmeroValor máximo del medidor.
codetextoCódigo del activo.
is_monitoredbooleanoIndica si el medidor está siendo monitoreado.
default_minnúmeroValor mínimo por defecto del medidor.
default_maxnúmeroValor máximo por defecto del medidor.
alert_high_preventive_valuenúmeroUmbral alto preventivo del estado del medidor. No aplica a contadores (is_counter = true).
alert_high_preventive_enabledbooleanoIndica si el umbral alto preventivo está habilitado.
alert_high_critical_valuenúmeroUmbral alto crítico del estado del medidor. No aplica a contadores (is_counter = true).
alert_high_critical_enabledbooleanoIndica si el umbral alto crítico está habilitado.
alert_low_preventive_valuenúmeroUmbral bajo preventivo del estado del medidor. No aplica a contadores (is_counter = true).
alert_low_preventive_enabledbooleanoIndica si el umbral bajo preventivo está habilitado.
alert_low_critical_valuenúmeroUmbral bajo crítico del estado del medidor. No aplica a contadores (is_counter = true).
alert_low_critical_enabledbooleanoIndica si el umbral bajo crítico está habilitado.
alert_current_statetextoEstado actual de alerta del medidor. Si no se ha registrado ningún cambio de estado, el valor es NORMAL.

Estructura de last_data:

ParámetroTipoDescripción
datetextoFecha de la última lectura (formato ISO 8601).
valuenúmeroValor de la última lectura.
accumulated_valuenúmeroValor acumulado del contador al momento de la última lectura.

Cómo obtener el valor acumulado de un contador

Para conocer el valor acumulado de un medidor de tipo contador, utiliza counter_value (valor acumulado actual) o last_data.accumulated_value (valor acumulado a la fecha de la última lectura).

El campo counter_offset_value corresponde al valor base del contador y no debe interpretarse como el acumulado.


Errores

CódigoCausa
404El código enviado en location_code no existe en la compañía.
500Error interno al procesar la consulta.

Ejemplo

Request

GET https://app.fracttal.com/api/meters/?code=12345&serial=4789

Response 200

{
    "success": true,
    "message": "200",
    "data": [
        {
            "id": 1001,
            "active": true,
            "description": "Horómetro generador",
            "serial": "4789",
            "is_counter": true,
            "counter_offset_value": 1500,
            "counter_value": 1620,
            "last_data": {
                "date": "2026-10-20T08:30:00+00:00",
                "value": 120,
                "accumulated_value": 1620
            },
            "monthly_average_data": 45,
            "units_description": "HORAS",
            "units_code": "HS",
            "items_description": "Generador eléctrico 01",
            "parent_description": "/ Planta principal / ",
            "monthly_average_auto": true,
            "min_value": null,
            "max_value": null,
            "code": "12345",
            "is_monitored": false,
            "default_min": 0,
            "default_max": 0,
            "alert_high_preventive_value": null,
            "alert_high_preventive_enabled": false,
            "alert_high_critical_value": null,
            "alert_high_critical_enabled": false,
            "alert_low_preventive_value": null,
            "alert_low_preventive_enabled": false,
            "alert_low_critical_value": null,
            "alert_low_critical_enabled": false,
            "alert_current_state": "NORMAL"
        }
    ],
    "total": 1
}

Response — ubicación no encontrada (404)

{
    "success": false,
    "message": "404",
    "data": [
        {
            "ERROR": "Location code LOC-999 was not found in your company"
        }
    ],
    "total": 0
}
Path Params
string
required
Language
LoadingLoading…