Telemetria

Endpoint de fator de potência de telemetria.

Opções de filtros

Por Empresa

Method URI Headers Authorization
POST /api/v3/dashboards/company/power-factor-data Content-Type:application/json Authorization: Bearer {token}

Attributes

id: (int, required) - "ID da empresa".
properties: (array, required) - "Dados de fator de potência." ('fator_potencia')
initial_date: (int, timestamp) - "Timestamp do início do período (Obrigatório se não enviar initial_date_syntax."
final_date: (int, timestamp) - "Timestamp do final do período (Obrigatório se não enviado final_date_syntax)."
initial_date_syntax: (string) - "Sintaxe relativa de tempo para o início do período."
final_date_syntax: (string) - "Sintaxe relativa de tempo para o final do período."
final_date_syntax_number: (int) - "Quantidade de uma sintaxe relativa de tempo. Ex. 1"
order: (string) - "Tipo de ordenação, aplicada ao horário." ('asc' ou 'desc')
order_by: (string) - "Campo usado na ordenação. Padrão timestamp" ('timestamp' ou 'valor')
limit: (int) - "Quantidade limite de registros"
aggregate: (string) - "Agregar os dados no período informado em (aggregation_interval e aggregation_interval_number) ou em 1 hora como default. Ex. max" 
aggregation_interval: (string) - "Intervalo para agregação dos dados. Ex. hours"
aggregation_interval_number: (int) - "Quantidade do intervalo de uma agragação. Ex. 1"
aggregation_timezone: (int) - "Timezone aplicado nos registros e na data inicial da requisição."
summarize_by: (string) - "Sumarização dos dados. Ex. sum"
filter_by_peak_time: (bool) - "Filtrar os dados por horário ponta e fora ponta."
accumulate: (bool) - "Acumula o valor dos dados de acordo com a frequência solicitada. Obs. Nâo pode ser utilizado com o summarize_by"
group_by: (string) - "Agrupar por entidade. Ex. company"


Response

{success} Response 200 (application/json)

{
    "series": [
        {
            "entity": "company",
            "entity_name": "Empresa Teste",
            "property": "fator_potencia",
            "data": [
                {
                    "timestamp": 1641009600,
                    "value": 0.89
                },
                {
                    "timestamp": 1641013200,
                    "value": 0.9
                }
            ]
        }
    ],
    "summary": null
}

{warning} Response 422 (application/json)

{
    "initial_date": [
        "O campo data inicial é obrigatório quando initial date syntax não está presente."
    ],
    "initial_date_syntax": [
        "O campo initial date syntax é obrigatório quando data inicial não está presente."
    ]
}

{primary} Response 204 (application/json).

Quando os critérios de parâmetros não contiver registros a serem retornados.