/api/v1/reports/monthly read:inventory Monthly operational report — nine metrics per UTC calendar month, computed on the fly each call. Each metric is a {value, coverage, note?} tuple: check coverage before trusting a value. cards_received reports as not_instrumented (value null, never 0) until receipts have been logged for your account; cards_remaining_in_storage is always a derived_estimate (intaken-to-date minus fulfilled-to-date — withdrawn and voided cards are NOT subtracted, so it drifts high if you withdraw inventory); all other metrics are instrumented.
GET /api/v1/reports/monthly?period=2026-08 These inputs are shared across all docs pages, so an id entered here carries over.
Not run yet. Press Run to make a live call against https://service.rip.fun (through this demo's server-side proxy; the API key never reaches the browser).
curl -X GET 'https://service.rip.fun/api/v1/reports/monthly?period=2026-08' \ -H 'X-API-Key: rip_…'
| Field | Type | Required | Description |
|---|---|---|---|
period | query string | yes | YYYY-MM. Missing or malformed returns 400 ("period must be YYYY-MM") |
data)| Field | Description |
|---|---|
report.period_start / period_end / generated_at | The UTC month + when this report was computed |
report.metrics | cards_received, cards_successfully_intaken, cards_fulfilled, cards_remaining_in_storage, material_intake_discrepancies, material_fulfillment_exceptions, mis_picks_fulfillment_errors, lost_or_damaged_inventory, open_investigations |
(each metric) | { value: number | null, coverage: "instrumented" | "derived_estimate" | "not_instrumented", note? } |
| Status | Code | When |
|---|---|---|
| 400 | period must be YYYY-MM | period missing, malformed, or month outside 01–12 |
| 404 | not found | account not found |
See Errors for the response envelope and the full code list.