Eden REST API

Analytics And Observability APIs

Source
ProtocolREST / JSON
Base path/api/v1
AuthenticationBearer token

These APIs expose fleet analytics, endpoint analytics, live streams, and telemetry exports used by operational dashboards and migration validation runs.

Route Map

Fleet Analytics

MethodRoutePurpose
GET/api/v1/analytics/statusReturn analytics pipeline status.
GET/api/v1/analytics/overviewReturn organization analytics overview.
POST/api/v1/analytics/enableEnable analytics capture.
POST/api/v1/analytics/disableDisable analytics capture.
GET/api/v1/analytics/dashboardReturn dashboard summary data.
GET/api/v1/analytics/connectionsReturn active connection metrics.
GET/api/v1/analytics/connections/streamStream active connection metrics.
GET/api/v1/analytics/anomalies/statusReturn current anomaly detector states.
GET/api/v1/analytics/anomalies/transitionsReturn anomaly state transitions.
GET/api/v1/analytics/fleet/signalsReturn fleet health signals.

Streams And Query Capture

MethodRoutePurpose
GET/api/v1/analytics/streamOpen the main analytics SSE stream.
GET/api/v1/analytics/stream/queriesOpen the live query SSE stream.
GET/api/v1/analytics/stream/queries/captureReturn query-capture status.
POST/api/v1/analytics/stream/queries/captureEnable capture-all query streaming.
DELETE/api/v1/analytics/stream/queries/captureDisable capture-all query streaming.

Telemetry Export

MethodRoutePurpose
GET/api/v1/analytics/telemetryExport telemetry rows by query parameters.
GET/api/v1/analytics/telemetry/{signal}Export one telemetry signal.
GET/api/v1/analytics/clickhouseAlias-compatible ClickHouse telemetry export.
GET/api/v1/analytics/clickhouse/{signal}Alias-compatible single-signal export.
GET/api/v1/analytics/seriesReturn compressed columnar time-series data.

Telemetry rows include telemetry_plane and data_class. The service binds queries to its configured private or public_marketplace plane; clients cannot request or override that isolation dimension. Series cache entries use the same plane binding. The data class is signal-owned: operational_metric, operational_log, or operational_trace.

Infrastructure Snapshots

MethodRoutePurpose
GET/api/v1/analytics/infrastructure/snapshotsList captured infrastructure snapshots.
GET/api/v1/analytics/infrastructure/snapshots/statsReturn snapshot aggregate stats.
GET/api/v1/analytics/infrastructure/snapshots/{snapshot_uuid}Return a single infrastructure snapshot.

Endpoint Analytics

MethodRoutePurpose
GET/api/v1/endpoints/{endpoint}/analytics/commands/rollupsReturn command rollups.
GET/api/v1/endpoints/{endpoint}/analytics/metricsReturn endpoint metric snapshots.
GET/api/v1/endpoints/{endpoint}/analytics/anti-patternsReturn anti-pattern findings.
GET/api/v1/endpoints/{endpoint}/analytics/blocked-commandsReturn blocked command history.
GET/api/v1/endpoints/{endpoint}/analytics/piiReturn PII detection findings.
GET/api/v1/endpoints/{endpoint}/analytics/audit-trailReturn audit trail entries.
GET/api/v1/endpoints/{endpoint}/analytics/patternsReturn discovered query patterns.
GET/api/v1/endpoints/{endpoint}/analytics/usersReturn per-user rollups.
GET/api/v1/endpoints/{endpoint}/analytics/recommendationsReturn generic endpoint recommendations.
GET/api/v1/endpoints/{endpoint}/analytics/mongo/recommendationsReturn MongoDB recommendations.
GET/api/v1/endpoints/{endpoint}/analytics/postgres/recommendationsReturn PostgreSQL recommendations.

PostgreSQL template optimization advice

Eden does not expose a public endpoint that collects PostgreSQL execution plans, runs EXPLAIN ANALYZE, executes candidate SQL, applies a rewrite, creates an index, or changes database configuration. PostgreSQL analytics recommendations are observational only.

The internal PostgresSqlAdviceEngine can assess recorded evidence for an authorized parameterized-template revision. It accepts only bounded plan observations and abstains unless the current template/schema/statistics/server/ role/search_path/collation identity matches the evidence, all required SQL semantics are proven with independent native results, and at least three matched runtime trials in an isolated approved fixture agree. Production can contribute only non-executing EXPLAIN evidence for a read-only verified template. Cost estimates are not speedup claims; generic/custom and cold/warm plan observations remain visible for operator review.

Each submitted plan, semantic, result, and runtime artifact is bound to the exact approved revision, raw source-SQL SHA-256, and the complete candidate ID/revision/version, bind count, normalizer metadata, and raw candidate-SQL SHA-256. That raw candidate digest prevents a literal-only substitution from reusing evidence with the same normalized fingerprint. Candidate SQL must preserve the source bind count and parse as exactly one PostgreSQL SELECT; multi-statements, SELECT INTO, locking clauses, and data-modifying CTEs are rejected.

A configured template-authority Ed25519 key must verify an attestation over that exact candidate identity and its bound role, search_path, schema, statistics, server, and collation context. The attestation must resolve every candidate function under that PostgreSQL context and only immutable or stable calls may pass; volatile, mutating, and unresolved functions fail closed. These checks apply before any no-slower fixture-trial result can become measured advice.

Audit Trail Pagination And Scope

GET /api/v1/endpoints/{endpoint}/analytics/audit-trail accepts range, command, success, min_latency_us, and limit filters. limit defaults to 500 and must be between 1 and 1,000.

Pagination is a stable keyset over (event_time, event_id). Pass both cursor_time and cursor_id from the previous response's next_cursor; supplying only one is rejected. total_count covers every matching event in the requested range, not only the current page.

The query always combines the authenticated organization UUID with the endpoint UUID. A caller cannot override the tenant scope with query parameters, and the route requires the endpoint audit permission.

Notes

  • Stream routes require clients to keep the HTTP connection open and handle reconnects.
  • Some analytics routes require the service to be built with analytics and stream features enabled.
  • Migration dashboards consume both aggregate analytics and endpoint analytics during live runs.
Help improve Eden Docs

Find something unclear or incomplete? Review the source and propose an update.

View on GitLab Updated November 4, 2026