# Poultry Farm Analytics API

## Docs

- [Admin overview and endpoints](https://docs.poultry.quader864.ir/api-reference/admin/admin-overview-and-endpoints.md): Admin overview and endpoints
- [Analyze data quality for a flock over a date range Detects: spikes, missing d...](https://docs.poultry.quader864.ir/api-reference/admin/analyze-data-quality-for-a-flock-over-a-date-range-detects:-spikes-missing-d.md): Analyze data quality for a flock over a date range Detects: spikes, missing data, negative balances, inconsistent consumption, etc.
- [Archive rule](https://docs.poultry.quader864.ir/api-reference/admin/archive-rule.md): Archive rule
- [Archive (soft-delete) a consumption model](https://docs.poultry.quader864.ir/api-reference/admin/archive-soft-delete-a-consumption-model.md): Archive (soft-delete) a consumption model
- [Create anomaly detection rule](https://docs.poultry.quader864.ir/api-reference/admin/create-anomaly-detection-rule.md): Create anomaly detection rule
- [Create consumption model](https://docs.poultry.quader864.ir/api-reference/admin/create-consumption-model.md): Create consumption model
- [Disable (pause) a rule](https://docs.poultry.quader864.ir/api-reference/admin/disable-pause-a-rule.md): Disable (pause) a rule
- [Enable a rule and optionally trigger detection job](https://docs.poultry.quader864.ir/api-reference/admin/enable-a-rule-and-optionally-trigger-detection-job.md): Enable a rule and optionally trigger detection job
- [Grant/revoke capabilities](https://docs.poultry.quader864.ir/api-reference/admin/grantrevoke-capabilities.md): Grant/revoke capabilities
- [List all models](https://docs.poultry.quader864.ir/api-reference/admin/list-all-models.md): List all models
- [List all open data quality issues (optionally filtered by flock)](https://docs.poultry.quader864.ir/api-reference/admin/list-all-open-data-quality-issues-optionally-filtered-by-flock.md): List all open data quality issues (optionally filtered by flock)
- [List all rules](https://docs.poultry.quader864.ir/api-reference/admin/list-all-rules.md): List all rules
- [List all users](https://docs.poultry.quader864.ir/api-reference/admin/list-all-users.md): List all users
- [Query parameters: flockId (required), fromDate, toDate (ISO dates)](https://docs.poultry.quader864.ir/api-reference/admin/query-parameters:-flockid-required-fromdate-todate-iso-dates.md): Query parameters: flockId (required), fromDate, toDate (ISO dates). Defaults to last 7 days. Returns per-day movement totals and compares computed closing balance vs recorded summary.
- [Resolve a data quality issue](https://docs.poultry.quader864.ir/api-reference/admin/resolve-a-data-quality-issue.md): Resolve a data quality issue
- [Retrieve a single consumption model](https://docs.poultry.quader864.ir/api-reference/admin/retrieve-a-single-consumption-model.md): Retrieve a single consumption model
- [Retrieve a single rule](https://docs.poultry.quader864.ir/api-reference/admin/retrieve-a-single-rule.md): Retrieve a single rule
- [System health check for admin dashboard](https://docs.poultry.quader864.ir/api-reference/admin/system-health-check-for-admin-dashboard.md): System health check for admin dashboard
- [System metrics and health](https://docs.poultry.quader864.ir/api-reference/admin/system-metrics-and-health.md): System metrics and health
- [Update anomaly rule](https://docs.poultry.quader864.ir/api-reference/admin/update-anomaly-rule.md): Update anomaly rule
- [Update model](https://docs.poultry.quader864.ir/api-reference/admin/update-model.md): Update model
- [View audit trail](https://docs.poultry.quader864.ir/api-reference/admin/view-audit-trail.md): View audit trail
- [Alternative: Compare last N cycles (query param) Query params: lastCycles (de...](https://docs.poultry.quader864.ir/api-reference/analytics-v2/alternative:-compare-last-n-cycles-query-param-query-params:-lastcycles-de.md): Alternative: Compare last N cycles (query param) Query params: lastCycles (default from config: 3, e.g., ?lastCycles=5)
- [Analyze root cause of a specific anomaly Anomaly types: high_mortality, low_p...](https://docs.poultry.quader864.ir/api-reference/analytics-v2/analyze-root-cause-of-a-specific-anomaly-anomaly-types:-high_mortality-low_p.md): Analyze root cause of a specific anomaly Anomaly types: high_mortality, low_production, feed_waste, weight_loss
- [API overview and available endpoints](https://docs.poultry.quader864.ir/api-reference/analytics-v2/api-overview-and-available-endpoints.md): API overview and available endpoints
- [Auto-detect anomalies in the cycle](https://docs.poultry.quader864.ir/api-reference/analytics-v2/auto-detect-anomalies-in-the-cycle.md): Auto-detect anomalies in the cycle
- [Benchmark a specific flock against all others Returns comparative analysis an...](https://docs.poultry.quader864.ir/api-reference/analytics-v2/benchmark-a-specific-flock-against-all-others-returns-comparative-analysis-an.md): Benchmark a specific flock against all others Returns comparative analysis and percentile ranking
- [Calculate FCR with bird-day normalization (accounts for daily mortality)](https://docs.poultry.quader864.ir/api-reference/analytics-v2/calculate-fcr-with-bird-day-normalization-accounts-for-daily-mortality.md): Calculate FCR with bird-day normalization (accounts for daily mortality)
- [Compare multiple cycles Body: { cycleIds: ["2025-1", "2025-2", "2025-3"] }](https://docs.poultry.quader864.ir/api-reference/analytics-v2/compare-multiple-cycles-body:-.md): Compare multiple cycles Body: { cycleIds: ["2025-1", "2025-2", "2025-3"] }
- [Compare multiple specific flocks Body: { flockIds: ["id1", "id2", "id3"], cyc...](https://docs.poultry.quader864.ir/api-reference/analytics-v2/compare-multiple-specific-flocks-body:-flockids:-["id1"-"id2"-"id3"]-cyc.md): Compare multiple specific flocks Body: { flockIds: ["id1", "id2", "id3"], cycleId: "2025-1" }
- [CRITICAL FIX: Compare any cycles from any flocks (same or different) Supports...](https://docs.poultry.quader864.ir/api-reference/analytics-v2/critical-fix:-compare-any-cycles-from-any-flocks-same-or-different-supports.md): CRITICAL FIX: Compare any cycles from any flocks (same or different) Supports: Same flock different cycles, different flocks same cycle, ANY combination Uses duration-adjusted metrics for fair comparison
- [Detect health crises by comparing to previous cycle (relative change detection)](https://docs.poultry.quader864.ir/api-reference/analytics-v2/detect-health-crises-by-comparing-to-previous-cycle-relative-change-detection.md): Detect health crises by comparing to previous cycle (relative change detection)
- [Enforce mandatory data fields for daily submission (fixes data collection gaps)](https://docs.poultry.quader864.ir/api-reference/analytics-v2/enforce-mandatory-data-fields-for-daily-submission-fixes-data-collection-gaps.md): Enforce mandatory data fields for daily submission (fixes data collection gaps)
- [Get advanced financial metrics Query params: config (JSON with eggValue, feed...](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-advanced-financial-metrics-query-params:-config-json-with-eggvalue-feed.md): Get advanced financial metrics Query params: config (JSON with eggValue, feedCostPerKg, etc.)
- [Get breed comparison analysis](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-breed-comparison-analysis.md): Get breed comparison analysis
- [Get breed-specific benchmarks Shows average performance metrics for all flock...](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-breed-specific-benchmarks-shows-average-performance-metrics-for-all-flock.md): Get breed-specific benchmarks Shows average performance metrics for all flocks of a specific breed
- [Get complete comprehensive analysis for a cycle (all 8 phases + 5 advanced fe...](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-complete-comprehensive-analysis-for-a-cycle-all-8-phases-+-5-advanced-fe.md): Get complete comprehensive analysis for a cycle (all 8 phases + 5 advanced features)
- [Get current flock age and production phase](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-current-flock-age-and-production-phase.md): Get current flock age and production phase
- [Get daily dashboard summary for the last N days Query params: days (default f...](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-daily-dashboard-summary-for-the-last-n-days-query-params:-days-default-f.md): Get daily dashboard summary for the last N days Query params: days (default from config: 7), date (specific date)
- [Get daily environmental averages for a flock](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-daily-environmental-averages-for-a-flock.md): Get daily environmental averages for a flock
- [Get directory of all flocks with metadata for comparison](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-directory-of-all-flocks-with-metadata-for-comparison.md): Get directory of all flocks with metadata for comparison
- [Get egg quality trend analysis](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-egg-quality-trend-analysis.md): Get egg quality trend analysis
- [Get executive summary only (abbreviated version)](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-executive-summary-only-abbreviated-version.md): Get executive summary only (abbreviated version)
- [Get feed batch performance analysis](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-feed-batch-performance-analysis.md): Get feed batch performance analysis
- [Get feed quality analysis for a flock](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-feed-quality-analysis-for-a-flock.md): Get feed quality analysis for a flock
- [Get health trend analysis and mortality patterns](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-health-trend-analysis-and-mortality-patterns.md): Get health trend analysis and mortality patterns
- [Get normalized metrics for a specific flock cycle Returns both raw and normal...](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-normalized-metrics-for-a-specific-flock-cycle-returns-both-raw-and-normal.md): Get normalized metrics for a specific flock cycle Returns both raw and normalized metrics for comparison
- [Get predictive insights and forecasts Query params: historicalCycles (comma-s...](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-predictive-insights-and-forecasts-query-params:-historicalcycles-comma-s.md): Get predictive insights and forecasts Query params: historicalCycles (comma-separated cycle IDs, default from config)
- [Get production stage-aware thresholds (fixes same-threshold problem) Query pa...](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-production-stage-aware-thresholds-fixes-same-threshold-problem-query-pa.md): Get production stage-aware thresholds (fixes same-threshold problem) Query params: stage (grower|prelay|layer|broiler)
- [Get revenue forecast specifically](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-revenue-forecast-specifically.md): Get revenue forecast specifically
- [Get ROI specifically](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-roi-specifically.md): Get ROI specifically
- [Get sale recommendation specifically](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-sale-recommendation-specifically.md): Get sale recommendation specifically
- [Get supplier reliability scores](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-supplier-reliability-scores.md): Get supplier reliability scores
- [Get time-series data for charts Query params: startDate, endDate, metrics (co...](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-time-series-data-for-charts-query-params:-startdate-enddate-metrics-co.md): Get time-series data for charts Query params: startDate, endDate, metrics (comma-separated: birds,feed,eggs)
- [Get water quality summary for a flock](https://docs.poultry.quader864.ir/api-reference/analytics-v2/get-water-quality-summary-for-a-flock.md): Get water quality summary for a flock
- [Pattern recognition: connects symptoms into unified diagnosis (cascade analysis)](https://docs.poultry.quader864.ir/api-reference/analytics-v2/pattern-recognition:-connects-symptoms-into-unified-diagnosis-cascade-analysis.md): Pattern recognition: connects symptoms into unified diagnosis (cascade analysis)
- [Record daily egg production and quality metrics](https://docs.poultry.quader864.ir/api-reference/analytics-v2/record-daily-egg-production-and-quality-metrics.md): Record daily egg production and quality metrics
- [Record data with age-based adjustments](https://docs.poultry.quader864.ir/api-reference/analytics-v2/record-data-with-age-based-adjustments.md): Record data with age-based adjustments
- [Record feed movement and quality metrics](https://docs.poultry.quader864.ir/api-reference/analytics-v2/record-feed-movement-and-quality-metrics.md): Record feed movement and quality metrics
- [Record mortality event with clinical details](https://docs.poultry.quader864.ir/api-reference/analytics-v2/record-mortality-event-with-clinical-details.md): Record mortality event with clinical details
- [Record new environmental reading for a flock](https://docs.poultry.quader864.ir/api-reference/analytics-v2/record-new-environmental-reading-for-a-flock.md): Record new environmental reading for a flock
- [Record water quality test results](https://docs.poultry.quader864.ir/api-reference/analytics-v2/record-water-quality-test-results.md): Record water quality test results
- [Show financial cost of performance issues (fixes financial blindness)](https://docs.poultry.quader864.ir/api-reference/analytics-v2/show-financial-cost-of-performance-issues-fixes-financial-blindness.md): Show financial cost of performance issues (fixes financial blindness)
- [Update flock hatch date and age tracking](https://docs.poultry.quader864.ir/api-reference/analytics-v2/update-flock-hatch-date-and-age-tracking.md): Update flock hatch date and age tracking
- [Add or confirm hypotheses (tags) for an anomaly](https://docs.poultry.quader864.ir/api-reference/anomalies/add-or-confirm-hypotheses-tags-for-an-anomaly.md): Add or confirm hypotheses (tags) for an anomaly. Body: { tags: ['tag1'], confirm: boolean, note: string }
- [Create manual anomaly (Admin)](https://docs.poultry.quader864.ir/api-reference/anomalies/create-manual-anomaly-admin.md): Create manual anomaly (Admin)
- [Get anomaly details](https://docs.poultry.quader864.ir/api-reference/anomalies/get-anomaly-details.md): Get anomaly details
- [Get only unresolved anomalies](https://docs.poultry.quader864.ir/api-reference/anomalies/get-only-unresolved-anomalies.md): Get only unresolved anomalies
- [List anomalies (role-filtered)](https://docs.poultry.quader864.ir/api-reference/anomalies/list-anomalies-role-filtered.md): List anomalies (role-filtered)
- [Mark anomaly as resolved](https://docs.poultry.quader864.ir/api-reference/anomalies/mark-anomaly-as-resolved.md): Mark anomaly as resolved
- [Change user role (Admin only)](https://docs.poultry.quader864.ir/api-reference/authentication/change-user-role-admin-only.md): Change user role (Admin only)
- [Get all pending verification users (Admin only)](https://docs.poultry.quader864.ir/api-reference/authentication/get-all-pending-verification-users-admin-only.md): Get all pending verification users (Admin only)
- [Get all users (Admin only)](https://docs.poultry.quader864.ir/api-reference/authentication/get-all-users-admin-only.md): Get all users (Admin only)
- [Get specific user details (Admin only)](https://docs.poultry.quader864.ir/api-reference/authentication/get-specific-user-details-admin-only.md): Get specific user details (Admin only)
- [Register new user account (requires verification)](https://docs.poultry.quader864.ir/api-reference/authentication/register-new-user-account-requires-verification.md): Register new user account (requires verification)
- [User login - returns JWT token](https://docs.poultry.quader864.ir/api-reference/authentication/user-login--returns-jwt-token.md): User login - returns JWT token
- [User logout (client should delete token)](https://docs.poultry.quader864.ir/api-reference/authentication/user-logout-client-should-delete-token.md): User logout (client should delete token)
- [Verify JWT token validity](https://docs.poultry.quader864.ir/api-reference/authentication/verify-jwt-token-validity.md): Verify JWT token validity
- [Verify/approve or reject pending user (Admin only)](https://docs.poultry.quader864.ir/api-reference/authentication/verifyapprove-or-reject-pending-user-admin-only.md): Verify/approve or reject pending user (Admin only)
- [Get compliance requirements](https://docs.poultry.quader864.ir/api-reference/compliance/get-compliance-requirements.md): Get compliance requirements
- [Get compliance status for a flock](https://docs.poultry.quader864.ir/api-reference/compliance/get-compliance-status-for-a-flock.md): Get compliance status for a flock
- [Get compliance violations](https://docs.poultry.quader864.ir/api-reference/compliance/get-compliance-violations.md): Get compliance violations
- [Get current analytics configuration Public endpoint (no auth required)](https://docs.poultry.quader864.ir/api-reference/configuration/get-current-analytics-configuration-public-endpoint-no-auth-required.md): Get current analytics configuration Public endpoint (no auth required)
- [Get default analytics configuration Admin only - for comparison/reset](https://docs.poultry.quader864.ir/api-reference/configuration/get-default-analytics-configuration-admin-only--for-comparisonreset.md): Get default analytics configuration Admin only - for comparison/reset
- [Reset config to defaults Admin only](https://docs.poultry.quader864.ir/api-reference/configuration/reset-config-to-defaults-admin-only.md): Reset config to defaults Admin only
- [Update analytics configuration Admin only](https://docs.poultry.quader864.ir/api-reference/configuration/update-analytics-configuration-admin-only.md): Update analytics configuration Admin only
- [Update only consumption section Admin only](https://docs.poultry.quader864.ir/api-reference/configuration/update-only-consumption-section-admin-only.md): Update only consumption section Admin only
- [Update only fallbacks section Admin only](https://docs.poultry.quader864.ir/api-reference/configuration/update-only-fallbacks-section-admin-only.md): Update only fallbacks section Admin only
- [Update only pricing section Admin only](https://docs.poultry.quader864.ir/api-reference/configuration/update-only-pricing-section-admin-only.md): Update only pricing section Admin only
- [Update only thresholds section Admin only](https://docs.poultry.quader864.ir/api-reference/configuration/update-only-thresholds-section-admin-only.md): Update only thresholds section Admin only
- [Create continuity plan](https://docs.poultry.quader864.ir/api-reference/continuity/create-continuity-plan.md): Create continuity plan
- [Get business continuity plans](https://docs.poultry.quader864.ir/api-reference/continuity/get-business-continuity-plans.md): Get business continuity plans
- [Get recovery time estimates](https://docs.poultry.quader864.ir/api-reference/continuity/get-recovery-time-estimates.md): Get recovery time estimates
- [Create a new cycle Request body: { "year": 2025, "n": 1 }](https://docs.poultry.quader864.ir/api-reference/cycles/create-a-new-cycle-request-body:-.md): Create a new cycle Request body: { "year": 2025, "n": 1 }
- [Create a new inventory movement for a cycle Request body examples: Bird inflo...](https://docs.poultry.quader864.ir/api-reference/cycles/create-a-new-inventory-movement-for-a-cycle-request-body-examples:-bird-inflo.md): Create a new inventory movement for a cycle Request body examples: Bird inflow: { "type": "bird_inflow", "date": "2025-01-15", "birdMetrics": { "count": 34000, "age": 16, "weightPerBird": 850 } } Weight measurement: { "type": "weight", "date": "2025-01-22", "weightMetrics": { "averageWeightGrams": 9…
- [Delete a movement (soft delete by default, hard delete with ?permanent=true) ...](https://docs.poultry.quader864.ir/api-reference/cycles/delete-a-movement-soft-delete-by-default-hard-delete-with-?permanent=true-.md): Delete a movement (soft delete by default, hard delete with ?permanent=true) Query parameters: - permanent (optional): true for hard delete, false (default) for soft delete
- [Get a specific movement with full details](https://docs.poultry.quader864.ir/api-reference/cycles/get-a-specific-movement-with-full-details.md): Get a specific movement with full details
- [Get all egg collections for the cycle Response: [ { "date": "2025-06-07", "co...](https://docs.poultry.quader864.ir/api-reference/cycles/get-all-egg-collections-for-the-cycle-response:-[-"date":-"2025-06-07"-"co.md): Get all egg collections for the cycle Response: [ { "date": "2025-06-07", "count": 6500, "avgWeight": 62, "totalWeight": 403, "phase": "early_production", "daysInProduction": 8 } ]
- [Get all feed records for the cycle Response: [ { "date": "2025-02-20", "consu...](https://docs.poultry.quader864.ir/api-reference/cycles/get-all-feed-records-for-the-cycle-response:-[-"date":-"2025-02-20"-"consu.md): Get all feed records for the cycle Response: [ { "date": "2025-02-20", "consumedKg": 3400, "feedType": "Layer Starter", "supplier": "PouletryFeed Inc", "phase": "growing", "daysInCycle": 36 } ]
- [Get all mortality events for the cycle Response: [ { "date": "2025-02-25", "c...](https://docs.poultry.quader864.ir/api-reference/cycles/get-all-mortality-events-for-the-cycle-response:-[-"date":-"2025-02-25"-"c.md): Get all mortality events for the cycle Response: [ { "date": "2025-02-25", "count": 3, "reason": "disease", "phase": "growing", "daysInCycle": 41 } ]
- [Get all movements for the cycle (optional type filter)](https://docs.poultry.quader864.ir/api-reference/cycles/get-all-movements-for-the-cycle-optional-type-filter.md): Get all movements for the cycle (optional type filter)
- [Get all weight measurements for the cycle Response: [ { "date": "2025-01-22",...](https://docs.poultry.quader864.ir/api-reference/cycles/get-all-weight-measurements-for-the-cycle-response:-[-"date":-"2025-01-22".md): Get all weight measurements for the cycle Response: [ { "date": "2025-01-22", "grams": 900, "method": "scale", "confidence": "high", "phase": "growing", "daysInCycle": 7 } ]
- [Get audit trail showing all changes made to a movement](https://docs.poultry.quader864.ir/api-reference/cycles/get-audit-trail-showing-all-changes-made-to-a-movement.md): Get audit trail showing all changes made to a movement
- [Get cycle summary with aggregate data](https://docs.poultry.quader864.ir/api-reference/cycles/get-cycle-summary-with-aggregate-data.md): Get cycle summary with aggregate data
- [Manually lock a movement to prevent editing Request body: { "reason": "Verifi...](https://docs.poultry.quader864.ir/api-reference/cycles/manually-lock-a-movement-to-prevent-editing-request-body:-"reason":-"verifi.md): Manually lock a movement to prevent editing Request body: { "reason": "Verified by manager" }
- [Unlock a manually locked movement (not auto-locked ones) Request body: { "rea...](https://docs.poultry.quader864.ir/api-reference/cycles/unlock-a-manually-locked-movement-not-auto-locked-ones-request-body:-"rea.md): Unlock a manually locked movement (not auto-locked ones) Request body: { "reason": "Correction needed" }
- [Update a movement (only if unlocked and < 7 days old) Request body: Partial u...](https://docs.poultry.quader864.ir/api-reference/cycles/update-a-movement-only-if-unlocked-and-<-7-days-old-request-body:-partial-u.md): Update a movement (only if unlocked and < 7 days old) Request body: Partial updates - only include fields to change { "reason": "purchase", "notes": "Updated notes", "confidence": "high", "birdMetrics": { "count": 34000 } }
- [Update cycle metadata (year, n, status) WARNING: Changing year/n updates all ...](https://docs.poultry.quader864.ir/api-reference/cycles/update-cycle-metadata-year-n-status-warning:-changing-yearn-updates-all-.md): Update cycle metadata (year, n, status) WARNING: Changing year/n updates all movements for this cycle
- [Update cycle status (active → ended)](https://docs.poultry.quader864.ir/api-reference/cycles/update-cycle-status-active-→-ended.md): Update cycle status (active → ended)
- [Dashboard overview and endpoints](https://docs.poultry.quader864.ir/api-reference/dashboard/dashboard-overview-and-endpoints.md): Dashboard overview and endpoints
- [Get comprehensive flock dashboard with all metrics Returns: - Bird inventory ...](https://docs.poultry.quader864.ir/api-reference/dashboard/get-comprehensive-flock-dashboard-with-all-metrics-returns:--bird-inventory-.md): Get comprehensive flock dashboard with all metrics Returns: - Bird inventory (current, capacity, losses today/total) - Food delivery (today, expected, lifetime, storage) - Food consumption (actual, expected, per-bird, variance) - Expected ranges (consumption, mortality) - Summary with key metrics an…
- [Get dashboard for all flocks (admin view)](https://docs.poultry.quader864.ir/api-reference/dashboard/get-dashboard-for-all-flocks-admin-view.md): Get dashboard for all flocks (admin view)
- [Get dashboard for supervisor's assigned flocks (summary view)](https://docs.poultry.quader864.ir/api-reference/dashboard/get-dashboard-for-supervisors-assigned-flocks-summary-view.md): Get dashboard for supervisor's assigned flocks (summary view)
- [Get cycle-specific analytics](https://docs.poultry.quader864.ir/api-reference/flock-analytics/get-cycle-specific-analytics.md): Get cycle-specific analytics
- [Get daily analytics data](https://docs.poultry.quader864.ir/api-reference/flock-analytics/get-daily-analytics-data.md): Get daily analytics data
- [Get flock analytics summary with day range Compatibility endpoint - redirects...](https://docs.poultry.quader864.ir/api-reference/flock-analytics/get-flock-analytics-summary-with-day-range-compatibility-endpoint--redirects.md): Get flock analytics summary with day range Compatibility endpoint - redirects to v2 endpoint
- [Create a new flock](https://docs.poultry.quader864.ir/api-reference/flocks/create-a-new-flock.md): Create a new flock
- [GET /api/v1/flocks/{id}](https://docs.poultry.quader864.ir/api-reference/flocks/get-apiv1flocks.md)
- [GET /api/v1/flocks/{id}/cycles](https://docs.poultry.quader864.ir/api-reference/flocks/get-apiv1flocks-cycles.md): **Auth middleware:** `verifyToken`.
- [List flocks](https://docs.poultry.quader864.ir/api-reference/flocks/list-flocks.md): List flocks. Supervisors limited to assigned flocks via `req.user.assignedFlocks`.
- [Soft-delete (archive) a flock](https://docs.poultry.quader864.ir/api-reference/flocks/soft-delete-archive-a-flock.md): Soft-delete (archive) a flock
- [Update flock](https://docs.poultry.quader864.ir/api-reference/flocks/update-flock.md): Update flock
- [Adjust movement (Supervisor+ only) Validates type-reason combinations](https://docs.poultry.quader864.ir/api-reference/inventory/adjust-movement-supervisor+-only-validates-type-reason-combinations.md): Adjust movement (Supervisor+ only) Validates type-reason combinations
- [Admin: Lock one or many days for a flock (prevents edits) Body: { flockId: st...](https://docs.poultry.quader864.ir/api-reference/inventory/admin:-lock-one-or-many-days-for-a-flock-prevents-edits-body:-flockid:-st.md): Admin: Lock one or many days for a flock (prevents edits) Body: { flockId: string, dates: ["YYYY-MM-DD"], reason: string }
- [Admin: Unlock one or many days for a flock (allows edits) Body: { flockId: st...](https://docs.poultry.quader864.ir/api-reference/inventory/admin:-unlock-one-or-many-days-for-a-flock-allows-edits-body:-flockid:-st.md): Admin: Unlock one or many days for a flock (allows edits) Body: { flockId: string, dates: ["YYYY-MM-DD"], reason: string }
- [Aggregated flock snapshot: capacity, age, alive, losses, loss%, expected feed...](https://docs.poultry.quader864.ir/api-reference/inventory/aggregated-flock-snapshot:-capacity-age-alive-losses-loss%-expected-feed.md): Aggregated flock snapshot: capacity, age, alive, losses, loss%, expected feed range, today's consumption status
- [Create new movement (raw data) Validates type-reason combinations via Movemen...](https://docs.poultry.quader864.ir/api-reference/inventory/create-new-movement-raw-data-validates-type-reason-combinations-via-movemen.md): Create new movement (raw data) Validates type-reason combinations via MovementEnums
- [Get all recorded metrics for a flock Includes weight gain, feed efficiency, a...](https://docs.poultry.quader864.ir/api-reference/inventory/get-all-recorded-metrics-for-a-flock-includes-weight-gain-feed-efficiency-a.md): Get all recorded metrics for a flock Includes weight gain, feed efficiency, and performance over time
- [Get current flock balance](https://docs.poultry.quader864.ir/api-reference/inventory/get-current-flock-balance.md): Get current flock balance
- [Get daily egg collection summary Query: ?date=YYYY-MM-DD (defaults to today)](https://docs.poultry.quader864.ir/api-reference/inventory/get-daily-egg-collection-summary-query:-?date=yyyy-mm-dd-defaults-to-today.md): Get daily egg collection summary Query: ?date=YYYY-MM-DD (defaults to today)
- [Get daily summaries (derived data) Auto-generates summaries from movements if...](https://docs.poultry.quader864.ir/api-reference/inventory/get-daily-summaries-derived-data-auto-generates-summaries-from-movements-if.md): Get daily summaries (derived data) Auto-generates summaries from movements if missing
- [Get egg collection statistics for a date range Query: ?startDate=YYYY-MM-DD&e...](https://docs.poultry.quader864.ir/api-reference/inventory/get-egg-collection-statistics-for-a-date-range-query:-?startdate=yyyy-mm-dd&e.md): Get egg collection statistics for a date range Query: ?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD&limit=50&skip=0
- [Get egg laying productivity metrics Query: ?startDate=YYYY-MM-DD&endDate=YYYY...](https://docs.poultry.quader864.ir/api-reference/inventory/get-egg-laying-productivity-metrics-query:-?startdate=yyyy-mm-dd&enddate=yyyy.md): Get egg laying productivity metrics Query: ?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD&flockSize=500
- [Get example input payload for a specific movement type Frontend can use this ...](https://docs.poultry.quader864.ir/api-reference/inventory/get-example-input-payload-for-a-specific-movement-type-frontend-can-use-this-.md): Get example input payload for a specific movement type Frontend can use this as a template or for testing
- [Get input schema for a specific movement type Frontend uses this to generate ...](https://docs.poultry.quader864.ir/api-reference/inventory/get-input-schema-for-a-specific-movement-type-frontend-uses-this-to-generate-.md): Get input schema for a specific movement type Frontend uses this to generate form fields for that movement type Example: GET /api/v1/inventory/input-schema/bird_inflow Returns: { type: 'bird_inflow', label: 'Bird Inflow', requiredFields: [...], optionalFields: [...] }
- [Get input schema for all movement types Frontend uses this to know what field...](https://docs.poultry.quader864.ir/api-reference/inventory/get-input-schema-for-all-movement-types-frontend-uses-this-to-know-what-field.md): Get input schema for all movement types Frontend uses this to know what fields to ask for each movement type Example response: { bird_inflow: { type, label, description, requiredFields, optionalFields }, ... }
- [Get specific movement](https://docs.poultry.quader864.ir/api-reference/inventory/get-specific-movement.md): Get specific movement
- [Inventory overview and endpoints](https://docs.poultry.quader864.ir/api-reference/inventory/inventory-overview-and-endpoints.md): Inventory overview and endpoints
- [Investigate egg breakage spike Query: ?date=YYYY-MM-DD (defaults to today)](https://docs.poultry.quader864.ir/api-reference/inventory/investigate-egg-breakage-spike-query:-?date=yyyy-mm-dd-defaults-to-today.md): Investigate egg breakage spike Query: ?date=YYYY-MM-DD (defaults to today)
- [List inventory movements (filtered by role)](https://docs.poultry.quader864.ir/api-reference/inventory/list-inventory-movements-filtered-by-role.md): List inventory movements (filtered by role)
- [Record weight and feed metrics for a flock Calculates daily rates and perform...](https://docs.poultry.quader864.ir/api-reference/inventory/record-weight-and-feed-metrics-for-a-flock-calculates-daily-rates-and-perform.md): Record weight and feed metrics for a flock Calculates daily rates and performance indicators IMPORTANT: Automatically accounts for mortality - feed per bird calculated only for living birds Body: { flockId: string, startWeightGrams: number, endWeightGrams: number, totalFeedConsumedKg: number, birdCo…
- [Soft delete movement (marks as deleted, keeps in DB) Records who deleted it a...](https://docs.poultry.quader864.ir/api-reference/inventory/soft-delete-movement-marks-as-deleted-keeps-in-db-records-who-deleted-it-a.md): Soft delete movement (marks as deleted, keeps in DB) Records who deleted it and when
- [Update breakage investigation details Body: { notes, severity }](https://docs.poultry.quader864.ir/api-reference/inventory/update-breakage-investigation-details-body:-.md): Update breakage investigation details Body: { notes, severity }
- [Validate input against schema before sending to API Body: the movement data o...](https://docs.poultry.quader864.ir/api-reference/inventory/validate-input-against-schema-before-sending-to-api-body:-the-movement-data-o.md): Validate input against schema before sending to API Body: the movement data object Returns: { valid: boolean, errors: string[] }
- [Deregister IoT device](https://docs.poultry.quader864.ir/api-reference/iot/deregister-iot-device.md): Deregister IoT device
- [Get device sensor data](https://docs.poultry.quader864.ir/api-reference/iot/get-device-sensor-data.md): Get device sensor data
- [Get IoT devices](https://docs.poultry.quader864.ir/api-reference/iot/get-iot-devices.md): Get IoT devices
- [Post sensor reading (from device)](https://docs.poultry.quader864.ir/api-reference/iot/post-sensor-reading-from-device.md): Post sensor reading (from device)
- [Register new IoT device](https://docs.poultry.quader864.ir/api-reference/iot/register-new-iot-device.md): Register new IoT device
- [Update device configuration](https://docs.poultry.quader864.ir/api-reference/iot/update-device-configuration.md): Update device configuration
- [Get incident details](https://docs.poultry.quader864.ir/api-reference/operations/get-incident-details.md): Get incident details
- [Get operational incidents](https://docs.poultry.quader864.ir/api-reference/operations/get-operational-incidents.md): Get operational incidents
- [Report a new incident](https://docs.poultry.quader864.ir/api-reference/operations/report-a-new-incident.md): Report a new incident
- [Resolve an incident](https://docs.poultry.quader864.ir/api-reference/operations/resolve-an-incident.md): Resolve an incident
- [Get efficiency metrics](https://docs.poultry.quader864.ir/api-reference/optimization/get-efficiency-metrics.md): Get efficiency metrics
- [Get optimization opportunities](https://docs.poultry.quader864.ir/api-reference/optimization/get-optimization-opportunities.md): Get optimization opportunities
- [Submit optimization recommendations](https://docs.poultry.quader864.ir/api-reference/optimization/submit-optimization-recommendations.md): Submit optimization recommendations
- [Poultry Farm Analytics API reference overview](https://docs.poultry.quader864.ir/api-reference/overview.md): Reference overview for the Poultry Farm Analytics API: authentication, request conventions, error handling, rate limits, and the full list of endpoint groups.
- [Get predictive failure analysis](https://docs.poultry.quader864.ir/api-reference/predictive/get-predictive-failure-analysis.md): Get predictive failure analysis
- [Get predictive maintenance schedule](https://docs.poultry.quader864.ir/api-reference/predictive/get-predictive-maintenance-schedule.md): Get predictive maintenance schedule
- [Health forecast for a flock](https://docs.poultry.quader864.ir/api-reference/predictive/health-forecast-for-a-flock.md): Health forecast for a flock
- [Add new supplier](https://docs.poultry.quader864.ir/api-reference/procurement/add-new-supplier.md): Add new supplier
- [Create procurement order](https://docs.poultry.quader864.ir/api-reference/procurement/create-procurement-order.md): Create procurement order
- [Get procurement orders](https://docs.poultry.quader864.ir/api-reference/procurement/get-procurement-orders.md): Get procurement orders
- [Get suppliers list](https://docs.poultry.quader864.ir/api-reference/procurement/get-suppliers-list.md): Get suppliers list
- [Acknowledge an alert](https://docs.poultry.quader864.ir/api-reference/rules/acknowledge-an-alert.md): Acknowledge an alert
- [Create a new rule (Supervisor+)](https://docs.poultry.quader864.ir/api-reference/rules/create-a-new-rule-supervisor+.md): Create a new rule (Supervisor+)
- [Get a specific rule](https://docs.poultry.quader864.ir/api-reference/rules/get-a-specific-rule.md): Get a specific rule
- [Get alerts for all flocks (optional flockId query parameter)](https://docs.poultry.quader864.ir/api-reference/rules/get-alerts-for-all-flocks-optional-flockid-query-parameter.md): Get alerts for all flocks (optional flockId query parameter)
- [Get all inputs enriched with their type information Frontend can use this to ...](https://docs.poultry.quader864.ir/api-reference/rules/get-all-inputs-enriched-with-their-type-information-frontend-can-use-this-to-.md): Get all inputs enriched with their type information Frontend can use this to populate dropdowns with full context
- [Get available calculation templates Shows what kind of calculations are possible](https://docs.poultry.quader864.ir/api-reference/rules/get-available-calculation-templates-shows-what-kind-of-calculations-are-possible.md): Get available calculation templates Shows what kind of calculations are possible
- [Get available data inputs for formula building Frontend uses this to populate...](https://docs.poultry.quader864.ir/api-reference/rules/get-available-data-inputs-for-formula-building-frontend-uses-this-to-populate.md): Get available data inputs for formula building Frontend uses this to populate dropdown suggestions
- [Get available rule types](https://docs.poultry.quader864.ir/api-reference/rules/get-available-rule-types.md): Get available rule types
- [Get data type definitions for validation and formatting Frontend uses this to...](https://docs.poultry.quader864.ir/api-reference/rules/get-data-type-definitions-for-validation-and-formatting-frontend-uses-this-to.md): Get data type definitions for validation and formatting Frontend uses this to understand how to handle different data types
- [Get detailed information about a specific input Frontend can call this when u...](https://docs.poultry.quader864.ir/api-reference/rules/get-detailed-information-about-a-specific-input-frontend-can-call-this-when-u.md): Get detailed information about a specific input Frontend can call this when user selects an input
- [Get example rules for common scenarios](https://docs.poultry.quader864.ir/api-reference/rules/get-example-rules-for-common-scenarios.md): Get example rules for common scenarios
- [Get list of all flocks for rule assignment](https://docs.poultry.quader864.ir/api-reference/rules/get-list-of-all-flocks-for-rule-assignment.md): Get list of all flocks for rule assignment
- [Get rules applicable to a specific flock](https://docs.poultry.quader864.ir/api-reference/rules/get-rules-applicable-to-a-specific-flock.md): Get rules applicable to a specific flock
- [Get smart rule suggestions based on flock type and age](https://docs.poultry.quader864.ir/api-reference/rules/get-smart-rule-suggestions-based-on-flock-type-and-age.md): Get smart rule suggestions based on flock type and age
- [List all active rules (or specific type/flock)](https://docs.poultry.quader864.ir/api-reference/rules/list-all-active-rules-or-specific-typeflock.md): List all active rules (or specific type/flock)
- [On-demand alert calculation for a flock and date Evaluates ALL rules (ignores...](https://docs.poultry.quader864.ir/api-reference/rules/on-demand-alert-calculation-for-a-flock-and-date-evaluates-all-rules-ignores.md): On-demand alert calculation for a flock and date Evaluates ALL rules (ignores anomalyDetection.enabled flag) and returns results Body: { flockId, date? }
- [Soft delete a rule (archive it)](https://docs.poultry.quader864.ir/api-reference/rules/soft-delete-a-rule-archive-it.md): Soft delete a rule (archive it)
- [Test a saved rule with sample data](https://docs.poultry.quader864.ir/api-reference/rules/test-a-saved-rule-with-sample-data.md): Test a saved rule with sample data
- [Test rule logic WITHOUT saving (for new rules being created) Body: { name, ty...](https://docs.poultry.quader864.ir/api-reference/rules/test-rule-logic-without-saving-for-new-rules-being-created-body:-name-ty.md): Test rule logic WITHOUT saving (for new rules being created) Body: { name, type, metric, threshold, ... } + testData
- [Update a rule (Supervisor+)](https://docs.poultry.quader864.ir/api-reference/rules/update-a-rule-supervisor+.md): Update a rule (Supervisor+)
- [Ingest a scale measurement](https://docs.poultry.quader864.ir/api-reference/scale/ingest-a-scale-measurement.md): Ingest a scale measurement
- [Query measurements by flockId and date range](https://docs.poultry.quader864.ir/api-reference/scale/query-measurements-by-flockid-and-date-range.md): Query measurements by flockId and date range
- [Create a new schedule](https://docs.poultry.quader864.ir/api-reference/schedules/create-a-new-schedule.md): Create a new schedule
- [Get schedules for a specific flock](https://docs.poultry.quader864.ir/api-reference/schedules/get-schedules-for-a-specific-flock.md): Get schedules for a specific flock
- [List all schedules](https://docs.poultry.quader864.ir/api-reference/schedules/list-all-schedules.md): List all schedules
- [Approve a transfer](https://docs.poultry.quader864.ir/api-reference/sharing/approve-a-transfer.md): Approve a transfer
- [Create a new transfer](https://docs.poultry.quader864.ir/api-reference/sharing/create-a-new-transfer.md): Create a new transfer
- [Get resource transfers](https://docs.poultry.quader864.ir/api-reference/sharing/get-resource-transfers.md): Get resource transfers
- [Get shared resources](https://docs.poultry.quader864.ir/api-reference/sharing/get-shared-resources.md): Get shared resources
- [Poultry Farm Analytics API documentation](https://docs.poultry.quader864.ir/index.md): Introduction to the Poultry Farm Analytics platform: flock management, inventory, IoT sensors, anomaly detection, and predictive analytics for farms.
- [Quickstart: authenticate and make your first API call](https://docs.poultry.quader864.ir/quickstart.md): Get started with the Poultry Farm Analytics API: create an account, obtain a JWT token, and make your first authenticated request to list flocks.

## OpenAPI Specs

- [openapi](https://docs.poultry.quader864.ir/openapi.json)

## Optional

- [Documentation](https://mintlify.com/docs)
- [Blog](https://mintlify.com/blog)