Consulta de medidores

get

https://app.fracttal.com/api/meters/{code}

Por meio desta API é consultada a lista de medidores criados no Fracttal. Ela permite filtrar para obter apenas os medidores de que você precisa: pelo código do ativo, pelo serial do medidor ou por uma localização.

Para obter os medidores que pertencem a um ativo específico, envie o parâmetro code (código do ativo).
Para obter as informações de um medidor específico, envie os parâmetros code (código do ativo) e serial (serial do medidor).
Para obter os medidores dos ativos vinculados a uma localização e às suas localizações secundárias (filhas), envie o parâmetro location_code.

Add-on
Uso geral — sem add-on específico.

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

Parâmetros de entrada

Parâmetro	Tipo	Obrigatório	Descrição
`code`	texto	Opcional	Código do ativo ao qual o medidor está associado.
`serial`	texto	Opcional	Serial do medidor que se deseja consultar.
`start`	inteiro	Opcional	Campo usado para paginar os registros. É o número em que a paginação começa. O padrão é 0.
`limit`	inteiro	Opcional	Quantidade de registros (itens) que se deseja que a API retorne. O padrão é 100 (não pode ser superior a esse valor).
`location_code`	texto	Opcional	Código da localização principal (localização pai) para consultar os medidores vinculados às suas localizações secundárias (filhas).

Parâmetros de saída

Parâmetro	Tipo	Descrição
`id`	inteiro	Identificador do medidor.
`active`	booleano	Indica o status do medidor, permitindo identificar se ele está habilitado ou não.
`description`	texto	Descrição do medidor.
`serial`	texto	Serial do medidor.
`is_counter`	booleano	Indica se o medidor é do tipo contador (acumulador).
`counter_offset_value`	número	Valor base do contador. É o valor sobre o qual as leituras são somadas para obter o acumulado; por exemplo, é atualizado quando o contador é reiniciado. Não é o valor acumulado.
`counter_value`	número	Valor acumulado atual do contador (valor base mais as leituras registradas).
`last_data`	objeto	Informações da última leitura adicionada ao medidor. Veja a estrutura na tabela a seguir.
`monthly_average_data`	número	Valor médio mensal.
`units_description`	texto	Descrição da unidade do medidor.
`units_code`	texto	Código da unidade do medidor.
`items_description`	texto	Descrição do ativo ao qual o medidor pertence.
`parent_description`	texto	Localização à qual o ativo pertence.
`monthly_average_auto`	booleano	Indica se a média mensal será calculada pelo sistema ou inserida manualmente pelo usuário.
`min_value`	número	Valor mínimo do medidor.
`max_value`	número	Valor máximo do medidor.
`code`	texto	Código do ativo.
`is_monitored`	booleano	Indica se o medidor está sendo monitorado.
`default_min`	número	Valor mínimo padrão do medidor.
`default_max`	número	Valor máximo padrão do medidor.
`alert_high_preventive_value`	número	Limite alto preventivo do estado do medidor. Não se aplica a contadores (`is_counter = true`).
`alert_high_preventive_enabled`	booleano	Indica se o limite alto preventivo está habilitado.
`alert_high_critical_value`	número	Limite alto crítico do estado do medidor. Não se aplica a contadores (`is_counter = true`).
`alert_high_critical_enabled`	booleano	Indica se o limite alto crítico está habilitado.
`alert_low_preventive_value`	número	Limite baixo preventivo do estado do medidor. Não se aplica a contadores (`is_counter = true`).
`alert_low_preventive_enabled`	booleano	Indica se o limite baixo preventivo está habilitado.
`alert_low_critical_value`	número	Limite baixo crítico do estado do medidor. Não se aplica a contadores (`is_counter = true`).
`alert_low_critical_enabled`	booleano	Indica se o limite baixo crítico está habilitado.
`alert_current_state`	texto	Estado atual de alerta do medidor. Se nenhuma mudança de estado tiver sido registrada, o valor é `NORMAL`.

Estrutura de last_data:

Parâmetro	Tipo	Descrição
`date`	texto	Data da última leitura (formato ISO 8601).
`value`	número	Valor da última leitura.
`accumulated_value`	número	Valor acumulado do contador no momento da última leitura.

Como obter o valor acumulado de um contador
Para saber o valor acumulado de um medidor do tipo contador, use counter_value (valor acumulado atual) ou last_data.accumulated_value (valor acumulado na data da última leitura).
O campo counter_offset_value corresponde ao valor base do contador e não deve ser interpretado como o acumulado.

Erros

Código	Causa
`404`	O código enviado em `location_code` não existe na empresa.
`500`	Erro interno ao processar a consulta.

Exemplo

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 gerador",
            "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": "Gerador elétrico 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 — localização não encontrada (`404`)

{
    "success": false,
    "message": "404",
    "data": [
        {
            "ERROR": "Location code LOC-999 was not found in your company"
        }
    ],
    "total": 0
}

Language

Loading…