Pular para o conteúdo

Endpoints de Dashboard

A API de Dashboard fornece insights em tempo real sobre operações de fazendas, desempenho de lotes e métricas de produção com análises abrangentes.

Todos os endpoints requerem autenticação.

Authorization: Bearer <token>

Obter estatísticas gerais da fazenda incluindo total de viveiros, lotes ativos e alertas.

GET /api/v1/dashboard/overview?farm_id={farm_id}
Authorization: Bearer <token>
ParâmetroTipoObrigatórioDescrição
farm_idUUIDID da fazenda
{
"farm_id": "farm-uuid",
"total_ponds": 12,
"active_batches": 8,
"total_active_alerts": 3,
"alerts_by_type": {
"LOW_OXYGEN": 2,
"HIGH_TEMPERATURE": 1
}
}

Obter resumos detalhados de todos os viveiros de uma fazenda incluindo informações do lote atual e cálculos de biomassa.

GET /api/v1/dashboard/ponds?farm_id={farm_id}
Authorization: Bearer <token>
{
"ponds": [
{
"pond_id": "pond-uuid-1",
"pond_cod": "VV-01",
"pond_type": "FATTENING",
"size_m2": 5000,
"has_active_batch": true,
"batch_id": "batch-uuid",
"batch_number": "LOTE-2026-001",
"days_in_production": 45,
"current_population": 212500,
"survival_rate": 85.0,
"current_biomass_kg": 850.0,
"biomass_per_m2": 0.17,
"average_weight_g": 4.0,
"status": "ACTIVE"
}
]
}

Obter crescimento histórico de biomassa ao longo do tempo para análise e visualização de tendências.

GET /api/v1/dashboard/biomass-trend?batch_id={batch_id}
Authorization: Bearer <token>
{
"batch_id": "batch-uuid",
"batch_number": "LOTE-2026-001",
"data_points": [
{
"date": "2026-01-08T00:00:00Z",
"days_in_production": 0,
"biomass_kg": 125.0,
"average_weight_g": 0.5
},
{
"date": "2026-02-19T00:00:00Z",
"days_in_production": 42,
"biomass_kg": 850.0,
"average_weight_g": 4.0
}
]
}

Obter análise de taxa de crescimento comparando peso atual vs peso esperado baseado em padrões da espécie.

GET /api/v1/dashboard/growth-rates?farm_id={farm_id}
Authorization: Bearer <token>
{
"batches": [
{
"batch_id": "batch-uuid",
"batch_number": "LOTE-2026-001",
"pond_cod": "VV-01",
"days_in_production": 42,
"species": "LITOPENAEUS_VANNAMEI",
"current_weight_g": 4.0,
"expected_weight_g": 4.2,
"weight_difference_g": -0.2,
"growth_rate_percent": 95.2,
"status": "BELOW_EXPECTED",
"weekly_growth_g": 0.67
}
]
}
StatusDescrição
ABOVE_EXPECTEDCrescendo mais rápido que o padrão
ON_TRACKCrescendo de acordo com o padrão (±5%)
BELOW_EXPECTEDCrescendo mais devagar que o padrão

Obter monitoramento de taxa de sobrevivência comparando população atual vs inicial.

GET /api/v1/dashboard/survival-rates?farm_id={farm_id}
Authorization: Bearer <token>
{
"batches": [
{
"batch_id": "batch-uuid",
"batch_number": "LOTE-2026-001",
"pond_cod": "VV-01",
"days_in_production": 42,
"initial_population": 250000,
"current_population": 212500,
"survival_rate": 85.0,
"mortality_count": 37500,
"status": "GOOD"
}
]
}
StatusLimiteDescrição
GOOD≥ 80%Excelente taxa de sobrevivência
ACCEPTABLE60-79%Taxa de sobrevivência aceitável
POOR< 60%Taxa baixa, intervenção necessária

Obter análise de eficiência alimentar incluindo FCA (Fator de Conversão Alimentar) e custo por kg.

GET /api/v1/dashboard/feed-efficiency?farm_id={farm_id}
Authorization: Bearer <token>
{
"batches": [
{
"batch_id": "batch-uuid",
"batch_number": "LOTE-2026-001",
"pond_cod": "VV-01",
"days_in_production": 42,
"total_feed_kg": 340.0,
"total_feed_cost": 5100.0,
"current_biomass_kg": 850.0,
"biomass_gained_kg": 725.0,
"fca": 1.8,
"cost_per_kg_feed": 15.0,
"feed_cost_per_kg_shrimp": 27.0,
"efficiency_status": "EXCELLENT"
}
]
}
StatusFaixa de FCADescrição
EXCELLENT< 1.5Eficiência alimentar excepcional
GOOD1.5-2.0Boa eficiência alimentar
ACCEPTABLE2.0-2.5Eficiência aceitável
POOR> 2.5Eficiência baixa, revisar estratégia