Skip to content

POST /api/v1/analytics/collect

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Collect

Trigger a collection run (idempotent; safe to re-run).

collect=false runs the cheap SYNCHRONOUS mode: external collectors are not called, only the ingest of already-fetched files and topic scoring run, and the caller gets the RESULT instead of an “accepted” — so a scheduled caller can tell whether the loop actually computed.

Auth: Authorization: Bearer <token> required

Terminal window
curl -sS -X POST "https://entherium.duckdns.org:8443/api/v1/analytics/collect" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"collect":"<collect>","date":"<date>","with_psi":"<with_psi>"}'

The contract carries no example for this response; schema: object. Field-level shape: interactive explorer.

object — Successful Response

ParameterInRequiredTypeDefaultConstraintsDescription
Idempotency-Keyheadernostring—uuidOptional.
FieldTypeRequiredDescription
collectbooleanno
datestring | nullno
with_psibooleanno
CodeMeaningBody
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.