Endpoint de resultados de Rateio para Dashboard.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| POST | /api/v3/dashboards/apportionment/company | Content-Type:application/json | Authorization: Bearer {token} |
id: (int, required) - "ID da empresa".
properties: (array, required) - "Dados de Rateio." ('total_value' ou 'equipments_value')
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 date" ('date','total_value' ou 'equipments_value')
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 agregaçã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"
group_by: (string) - "Agrupar por entidade. Ex. cost_center"{success} Response 200 (application/json)
{
"series": [
{
"entity": "company",
"entity_name": "Empresa 1",
"property": "total_value",
"data": [
{
"timestamp": 1717210800,
"value": 168.08,
"origem": null
},
{
"timestamp": 1714532400,
"value": 523,
"origem": null
}
]
}
],
"summary": [
{
"entity": "company",
"entity_name": "Empresa 1",
"property": "total_value",
"data": {
"timestamp": 1717210800,
"value": 691.08,
"origem": null
}
}
]
}{success} Response 200 (application/json)
{
"series": [
{
"entity": "cost_center",
"entity_name": "Centro de Custo 1",
"property": "total_value",
"data": []
},
{
"entity": "cost_center",
"entity_name": "Centro de Custo 2",
"property": "total_value",
"data": [
{
"timestamp": 1714532400,
"value": 261.5,
"origem": null
},
{
"timestamp": 1717210800,
"value": 84.54,
"origem": null
}
]
},
{
"entity": "cost_center",
"entity_name": "Centro de Custo 3",
"property": "total_value",
"data": [
{
"timestamp": 1714532400,
"value": 261.5,
"origem": null
},
{
"timestamp": 1717210800,
"value": 83.54,
"origem": null
}
]
},
{
"entity": "cost_center",
"entity_name": "Centro de Custo 1 - Rateio 2",
"property": "total_value",
"data": []
}
],
"summary": [
{
"entity": "cost_center",
"entity_name": "Centro de Custo 1",
"property": "total_value",
"data": {
"timestamp": null,
"value": null,
"origem": null
}
},
{
"entity": "cost_center",
"entity_name": "Centro de Custo 2",
"property": "total_value",
"data": {
"timestamp": 1717210800,
"value": 346.04,
"origem": null
}
},
{
"entity": "cost_center",
"entity_name": "Centro de Custo 3",
"property": "total_value",
"data": {
"timestamp": 1717210800,
"value": 345.04,
"origem": null
}
},
{
"entity": "cost_center",
"entity_name": "Centro de Custo 1 - Rateio 2",
"property": "total_value",
"data": {
"timestamp": null,
"value": null,
"origem": 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.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| POST | /api/v3/dashboards/apportionment/equipment | Content-Type:application/json | Authorization: Bearer {token} |
id: (int, required) - "ID do equipamento".
properties: (array, required) - "Dados de Rateio." ('total_value')
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 date" ('date','total_value' ou 'equipments_value')
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 agregaçã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"
group_by: (string) - "Agrupar por entidade. Ex. cost_center"{success} Response 200 (application/json)
{
"series": [
{
"entity": "equipment",
"entity_name": "Equipamento 1",
"property": "value",
"data": [
{
"timestamp": 1717210800,
"value": 33.54,
"origem": null
},
{
"timestamp": 1717210800,
"value": 33.54,
"origem": null
},
{
"timestamp": 1714532400,
"value": 211.5,
"origem": null
},
{
"timestamp": 1714532400,
"value": 211.5,
"origem": null
}
]
}
],
"summary": [
{
"entity": "equipment",
"entity_name": "Equipamento 1",
"property": "value",
"data": {
"timestamp": 1717210800,
"value": 490.08,
"origem": null
}
}
]
}{success} Response 200 (application/json)
{
"series": [
{
"entity": "cost_center",
"entity_name": "Centro de Custo 1",
"property": "total_value",
"data": [
{
"timestamp": 1714532400,
"value": 261.5,
"origem": null
},
{
"timestamp": 1717210800,
"value": 84.54,
"origem": null
}
]
},
{
"entity": "cost_center",
"entity_name": "Centro de Custo 2",
"property": "total_value",
"data": [
{
"timestamp": 1714532400,
"value": 261.5,
"origem": null
},
{
"timestamp": 1717210800,
"value": 83.54,
"origem": null
}
]
}
],
"summary": [
{
"entity": "cost_center",
"entity_name": "Centro de Custo 1",
"property": "total_value",
"data": {
"timestamp": 1717210800,
"value": 346.04,
"origem": null
}
},
{
"entity": "cost_center",
"entity_name": "Centro de Custo 2",
"property": "total_value",
"data": {
"timestamp": 1717210800,
"value": 345.04,
"origem": 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.