Top Consumos

Endpoint top consumo lista as top propriedades (property) de um grupo de entidades (ids) informadas no request.

Usando a opção summarize_top é possível retornar o resultado de X entidades de forma individual e o restante das entidades é retornado de forma agrupada.


data_source disponíveis:

  • property - Ex: active, reactive, vbatt
  • processed - Opções: modulacao (R$)
  • demand - Opções: demanda_ativa (kW) e demanda_reativa (kvar)
  • consumption - Opções: consumo_ativo (kWh) e consumo_reativo (kvarh)
  • powerFactor - Opção: fator_potencia
  • reactiveMagnitude - Opção: demanda_reativa_excedente (kvar)

Por Equipamento

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

Attributes

ids: [1, 2, 3, 4] (array, required) - "Ids de equipamentos."
property: `active` (string, required) - "Dado desejado."
data_source: `property` (string, required) - "Fonte do dado desejado."
summarize_by: `max` (string, required) - "Sumarizar dados selecionados."
summarize_top: 2 (integer, optional) - "Quantidade de entidades que serão exibidas individualmente."
summarize_order: `desc` (string, optional) - "Tipo de ordenação aplicado no top resultado."
initial_date: 1596829620 (integer, optional) - "Timestamp inicial. Obrigatório se não enviado initial_date_syntax."
final_date: 1596829620 (integer, optional) - "Timestamp final. Obrigatório se não enviado final_date_syntax."
initial_date_syntax: `month_ago` (string, optional) - "Sintaxe relativa de tempo para obter o timestamp inicial."
initial_date_syntax_number: 2 (integer, optional) - "Quando aplicável, quantidade de uma sintaxe relativa de tempo. Default: 1."
final_date_syntax: `hours_ago` (string, optional) - "Sintaxe relativa de tempo para obter o timestamp final."
final_date_syntax_number: 1 (integer, optional) - "Quando aplicável, quantidade de uma sintaxe relativa de tempo. Default: 1."
filter_by_peak_time: true (boolean, option) - "Filtrar dados por horário ponta, quando aplicável."


Body

{
    "ids": [1, 2, 3, 4],
    "property": "active",
    "data_source": "property",
    "summarize_by": "sum",
    "summarize_order": "desc",
    "summarize_top": 2,
    "initial_date": 1609459200,
    "final_date": 1612137600,
    "initial_date_syntax": "this_month",
    "final_date_syntax": "today"
}

Response

{success} Response 200 (application/json)

{
    "series": null,
    "summary": [
        {
            "entity": "equipment",
            "entity_name": "equipment A",
            "property": "active",
            "data": {
                "timestamp": 1609459200,
                "value": 10
            }
        },
        {
            "entity": "equipment",
            "entity_name": "equipment B",
            "property": "active",
            "data": {
                "timestamp": 1609459200, 
                "value": 10
            }
        },
        {
            "entity": "equipment",
            "entity_name": "Outros",
            "property": "active",
            "data": {
                "timestamp": 1609459200,
                "value": 20
            }
        }
    ]
}

Response

{warning} Response 422 (application/json)

Response

Quando todos os equipamentos informados no request não possuírem dispositivo e o data_source for do tipo property.

{primary} Response 204 (application/json)


Por Empresa

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

Attributes

ids: [1, 2, 3, 4] (array, required) - "Ids de empresas."
property: `active` (string, required) - "Dado desejado."
group_by: `company` (string, optional) - "Agrupar os dados. Opções: company e equipment. Default: equipment. Utilizado apenas quando data_source for igual a property."
data_source: `property` (string, required) - "Fonte do dado desejado."
summarize_by: `max` (string, required) - "Summarizar dados selecionados."
summarize_top: 2 (integer, optional) - "Quantidade de entidades que serão exibidas individualmente."
summarize_order: `desc` (string, optional) - "Tipo de ordenação aplicado no top resultado."
initial_date: 1596829620 (integer, optional) - "Timestamp inicial. Obrigatório se não enviado initial_date_syntax."
final_date: 1596829620 (integer, optional) - "Timestamp final. Obrigatório se não enviado final_date_syntax."
initial_date_syntax: `month_ago` (string, optional) - "Sintaxe relativa de tempo para obter o timestamp inicial."
initial_date_syntax_number: 2 (integer, optional) - "Quando aplicável, quantidade de uma sintaxe relativa de tempo. Default: 1."
final_date_syntax: `hours_ago` (string, optional) - "Sintaxe relativa de tempo para obter o timestamp final."
final_date_syntax_number: 1 (integer, optional) - "Quando aplicável, quantidade de uma sintaxe relativa de tempo. Default: 1."


Body

{
    "ids": [1, 2, 3, 4],
    "property": "active",
    "group_by": "company",
    "data_source": "property",
    "summarize_by": "sum",
    "summarize_order": "desc",
    "summarize_top": 2,
    "initial_date": 1609459200,
    "final_date": 1612137600,
    "initial_date_syntax": "this_month",
    "final_date_syntax": "today"
}

Response

{success} Response 200 (application/json)

{
    "series": null,
    "summary": [
        {
            "entity": "company",
            "entity_name": "company A",
            "property": "active",
            "data": {
                "timestamp": 1609459200,
                "value": 10
            }
        },
        {
            "entity": "company",
            "entity_name": "company B",
            "property": "active",
            "data": {
                "timestamp": 1609459200, 
                "value": 10
            }
        },
        {
            "entity": "company",
            "entity_name": "Outros",
            "property": "active",
            "data": {
                "timestamp": 1609459200,
                "value": 20
            }
        }
    ]
}

Response

{warning} Response 422 (application/json)

Response

Quando todas as empresas informadas no request não possuírem equipamento e dispositivo.

{primary} Response 204 (application/json)