Quick Ingestion Workflow
Simplified 3-step workflow that combines upload and metric processing into a single
request. By including metrics in the initial upload, the system automatically
validates, stages, and processes metrics — no separate PUT request needed.
The workflow is shaped around one trade-off: it drops the review gate of the full
ingestion flow in exchange for fewer calls. Requesting metrics at upload time is
what removes the manual staging pause, so the task runs straight through to
completed — which is why this path suits automated, known-good data rather than
work that needs a human to inspect the matched rows first.
▶Use cases
- Automated data pipelines — upload and process in one step without manual review, ideal for scheduled batch jobs
- Known-good data — skip the validation review stage when you trust the input data quality
- Rapid prototyping — quickly ingest sample data and see metrics without navigating the full multi-step flow
- CI/CD integration testing — run a complete upload-to-metrics cycle in a single automated test
▶Overview
Upload File (with metrics) ──→ Poll until completed ──→ Get Results + Visualization
│ │
├── metrics: ["deforestation", "emissions"] ├── Get Facilities (4a)
├── tags: batch-q1 ├── Get Plots (4b)
└── commodity_type: palm ├── Get Deforestation (4c)
└── Get Emissions (4d)
│
▼
HTML Table + Map
▶Steps
▶1. Upload with Metrics (POST /ingestions/assets)
POST /ingestions/assets)Upload a file with metrics included in the multipart form. The system
validates, geocodes, matches locations, and processes metrics automatically.
Frontend: Show upload confirmation with task ID. Begin polling immediately.
▶2. Check Status (GET /ingestions/:id/summary)
GET /ingestions/:id/summary)Poll until overall_status is completed. The task progresses through:
pending → staging → staged → processing → completed.
Frontend: Progress bar from status_counts.
▶3. Get Results (GET /ingestions/assets/:id)
GET /ingestions/assets/:id)Retrieve processed entities with completed metrics.
Frontend: Results table with metric columns.
▶4. Combined Visualization
Chains steps 4a–4d to gather facilities, plots, and metrics, then renders an HTML table with summary cards and a Leaflet.js map.
▶Comparison with Full Workflow
| Quick Ingestion | Facility / Supplier Ingestion | |
|---|---|---|
| Steps | 3 (+visualization) | 5 (+visualization) |
| Metrics set at | Upload (Step 1) | Separate PUT (Step 4) |
| Review before processing | No | Yes (Step 3) |
| Use case | Automated pipelines, known-good data | Manual review, selective processing |
▶Prerequisites
- Valid API key in
x-api-keyheader