API · v1 · stabil
CODEMETA OS Developer Center
Konsole öffnen
Module

Analytics

Analytics liefert konsolidierte Kennzahlen aus dem Live-System. Aggregations-Werte werden im Hintergrund vorberechnet; CRUD-Endpoints existieren primär für Konfiguration (Widgets, Dimensionen, Custom- Berechnungen).

Resources – Modell & Daten

ResourcePfadPermission-Präfix
Datasources/api/v1/analytics_datasourcesanalytics_datasource
Datenmodelle/api/v1/analytics_data_modelsanalytics_data_model
Beziehungen/api/v1/analytics_relationshipsanalytics_relationship
Metric-Definitionen/api/v1/analytics_metric_definitionsanalytics_metric_definition
Calculated Measures/api/v1/analytics_calculated_measuresanalytics_calculated_measure
Queries/api/v1/analytics_queriesanalytics_query
Snapshots/api/v1/analytics_snapshotsanalytics_snapshot
Retention-Policies/api/v1/analytics_retention_policiesanalytics_retention_policy

Resources – Dashboards & Widgets

ResourcePfadPermission-Präfix
Dashboards/api/v1/analytics_dashboardsanalytics_dashboard
Widgets/api/v1/analytics_widgetsanalytics_widget
Annotationen/api/v1/analytics_annotationsanalytics_annotation
Kommentare/api/v1/analytics_commentsanalytics_comment
Share-Links/api/v1/analytics_share_linksanalytics_share_link

Resources – Reports & Alerts

ResourcePfadPermission-Präfix
Report-Templates/api/v1/analytics_report_templatesanalytics_report_template
Report-Schedules/api/v1/analytics_report_schedulesanalytics_report_schedule
Report-Runs/api/v1/analytics_report_runsanalytics_report_run
Alert-Rules/api/v1/analytics_alert_rulesanalytics_alert_rule

Resources – Domänenspezifische Aggregate

ResourcePfadQuelle
Benchmark-Beiträge/api/v1/analytics_benchmark_contributionsBranchen-Benchmarks
License-Reconciliations/api/v1/analytics_license_reconciliationsSoftware-Lizenz-Audit
Remediation-Logs/api/v1/analytics_remediation_logsCompliance
Service-Time-Profiles/api/v1/analytics_service_time_profilesSLA-Profile
Simulationen/api/v1/analytics_simulationsSzenario-Analysen

Permissions folgen dem Schema <resource>_view / _create / _update / _delete.

Schemas — Konfiguration

Datasource

analytics_datasources4 Permissions
name string erforderlich
1–200 Zeichen
description string optional
max 2000 Zeichennullable
type string erforderlich
Werte
postgresqlmysqlmssqlrest_apicsvexcelgoogle_sheets
connectionConfig object optional

Connection parameters (host, port, database, URL, ...). Secret-named fields (password, apiKey, token, bearerToken, accessToken, refreshToken, privateKey, clientSecret, secret) are transparently encrypted at rest using AES-256-GCM via ANALYTICS_DATASOURCE_KEY. API responses mask these fields as "***".

nullable
syncInterval string optional
Werte
manualhourlydailyweekly
Default: "daily"
syncCron string optional

Optional 5-field cron expression overriding syncInterval. Evaluated in UTC. When set, the scheduler uses this instead of the interval preset.

max 100 Zeichennullable
lastSyncAt datetime optional
read-onlynullable
lastSyncStatus string optional
Werte
successerrorrunning
read-onlynullable
lastSyncError string optional
max 2000 Zeichenread-onlynullable
lastSyncDurationMs integer optional
≥ 0read-onlynullable
nextSyncAt datetime optional
read-onlynullable
schemaMapping object[] optional
Default: []nullable
transformRules object[] optional
Default: []nullable
isActive boolean optional
Default: true
cachedRowCount integer optional
≥ 0read-onlynullable
uploadMetadata object optional

CSV/Excel-only: metadata about the latest uploaded file (Phase B). Filled by the upload-complete handler and consumed by the ingest job.

read-onlynullable
fileKey string optional
originalFileName string optional
rowCount integer optional
≥ 0
columnSample string[] optional
delimiter string optional
encoding string optional
hasHeader boolean optional

Custom-Endpoints (/api/v1/analytics/...)

Über CRUD hinaus gibt es ~17 dedizierte Analytics-Endpoints für Live-Queries und Aggregations-Trigger. Auszug:

OperationHinweis
POST /api/v1/analytics/queryAd-hoc-Query gegen Dimensionen + Maßzahlen
POST /api/v1/analytics/widgets/<id>/recalculateRe-Calc eines Widgets
GET /api/v1/analytics/datasourcesVerfügbare Datenquellen
GET /api/v1/analytics/benchmarks/<dimension>Branchen-Benchmark abrufen
POST /api/v1/analytics/simulationsSzenario starten

Die vollständige, immer aktuelle Liste finden Sie in der OpenAPI-Spec.

Custom-Widgets

User-erstellte Widgets liegen in analytics_widgets. Der Body trägt:

{
  "name": "Tickets pro Woche, Top-10-Kunden",
  "kind": "bar_chart",
  "query": {
    "dimensions": ["week", "partyId"],
    "measures": ["ticket_count"],
    "filters": [],
    "limit": 10,
    "sortBy": "ticket_count:desc"
  }
}

Verwandt

  • Konventionen
  • Module-Seiten — jede Aggregat-Tabelle hängt an einem Modul

Suche