Endpoints de Dashboard
Visão Geral
Seção intitulada “Visão Geral”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>GET /dashboard/overview
Seção intitulada “GET /dashboard/overview”Obter estatísticas gerais da fazenda incluindo total de viveiros, lotes ativos e alertas.
Requisição
Seção intitulada “Requisição”GET /api/v1/dashboard/overview?farm_id={farm_id}Authorization: Bearer <token>Parâmetros de Query
Seção intitulada “Parâmetros de Query”| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
farm_id | UUID | ✅ | ID da fazenda |
Resposta 200 OK
Seção intitulada “Resposta 200 OK”{ "farm_id": "farm-uuid", "total_ponds": 12, "active_batches": 8, "total_active_alerts": 3, "alerts_by_type": { "LOW_OXYGEN": 2, "HIGH_TEMPERATURE": 1 }}GET /dashboard/ponds
Seção intitulada “GET /dashboard/ponds”Obter resumos detalhados de todos os viveiros de uma fazenda incluindo informações do lote atual e cálculos de biomassa.
Requisição
Seção intitulada “Requisição”GET /api/v1/dashboard/ponds?farm_id={farm_id}Authorization: Bearer <token>Resposta 200 OK
Seção intitulada “Resposta 200 OK”{ "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" } ]}GET /dashboard/biomass-trend
Seção intitulada “GET /dashboard/biomass-trend”Obter crescimento histórico de biomassa ao longo do tempo para análise e visualização de tendências.
Requisição
Seção intitulada “Requisição”GET /api/v1/dashboard/biomass-trend?batch_id={batch_id}Authorization: Bearer <token>Resposta 200 OK
Seção intitulada “Resposta 200 OK”{ "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 } ]}GET /dashboard/growth-rates
Seção intitulada “GET /dashboard/growth-rates”Obter análise de taxa de crescimento comparando peso atual vs peso esperado baseado em padrões da espécie.
Requisição
Seção intitulada “Requisição”GET /api/v1/dashboard/growth-rates?farm_id={farm_id}Authorization: Bearer <token>Resposta 200 OK
Seção intitulada “Resposta 200 OK”{ "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 } ]}Status de Crescimento
Seção intitulada “Status de Crescimento”| Status | Descrição |
|---|---|
ABOVE_EXPECTED | Crescendo mais rápido que o padrão |
ON_TRACK | Crescendo de acordo com o padrão (±5%) |
BELOW_EXPECTED | Crescendo mais devagar que o padrão |
GET /dashboard/survival-rates
Seção intitulada “GET /dashboard/survival-rates”Obter monitoramento de taxa de sobrevivência comparando população atual vs inicial.
Requisição
Seção intitulada “Requisição”GET /api/v1/dashboard/survival-rates?farm_id={farm_id}Authorization: Bearer <token>Resposta 200 OK
Seção intitulada “Resposta 200 OK”{ "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" } ]}Status de Sobrevivência
Seção intitulada “Status de Sobrevivência”| Status | Limite | Descrição |
|---|---|---|
GOOD | ≥ 80% | Excelente taxa de sobrevivência |
ACCEPTABLE | 60-79% | Taxa de sobrevivência aceitável |
POOR | < 60% | Taxa baixa, intervenção necessária |
GET /dashboard/feed-efficiency
Seção intitulada “GET /dashboard/feed-efficiency”Obter análise de eficiência alimentar incluindo FCA (Fator de Conversão Alimentar) e custo por kg.
Requisição
Seção intitulada “Requisição”GET /api/v1/dashboard/feed-efficiency?farm_id={farm_id}Authorization: Bearer <token>Resposta 200 OK
Seção intitulada “Resposta 200 OK”{ "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" } ]}Status de FCA
Seção intitulada “Status de FCA”| Status | Faixa de FCA | Descrição |
|---|---|---|
EXCELLENT | < 1.5 | Eficiência alimentar excepcional |
GOOD | 1.5-2.0 | Boa eficiência alimentar |
ACCEPTABLE | 2.0-2.5 | Eficiência aceitável |
POOR | > 2.5 | Eficiência baixa, revisar estratégia |