API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · analytics_widgets

Analytics Widget

Schema-ID
analytics_widget
Collection
analytics_widgets
Permissions
  • Lesenanalytics_dashboard_view
  • Anlegenanalytics_dashboard_create
  • Ändernanalytics_dashboard_edit
  • Löschenanalytics_dashboard_delete

Felder

Analytics Widget

analytics_widgets4 Permissions
titlestringerforderlich
1–200 Zeichen
descriptionstringoptional
max 1000 Zeichennullable
dashboardIduuidoptional
nullable
predefinedDashboardIdstringoptional
1–100 Zeichennullable
scopestringoptional
Werte
tenantuser
nullable
ownerUserIdstringoptional
nullable
xintegeroptional
≥ 0nullable
yintegeroptional
≥ 0nullable
wintegeroptional
≥ 1nullable
hintegeroptional
≥ 1nullable
tabIdstringoptional
nullable
queryIduuidoptional
nullable
chartTypestringerforderlich
Werte
kpi_cardlinebarhorizontal_barstacked_bargrouped_bardoughnutpieareastacked_areaheatmapscattergaugefunneltablepivot_tabletreemapradarwaterfallhistogram
inlineQueryobjectoptional
nullable
collectionstringoptional
min 1 Zeichen
pipelineobject[]optional
Default: []
fieldProjectionsstring[]optional
Default: []nullable
configobjectoptional
nullable
xFieldstringoptional
nullable
yFieldstringoptional
nullable
seriesFieldstringoptional
nullable
valueFieldstringoptional
nullable
labelFieldstringoptional
nullable
unitstringoptional
nullable
currencystringoptional
nullable
precisionintegeroptional
0 – 4nullable
invertColorsbooleanoptional
Default: falsenullable
showTrendbooleanoptional
Default: truenullable
showSparklinebooleanoptional
Default: falsenullable
comparisonPeriodstringoptional
Werte
previous_periodprevious_year
nullable
thresholdsobjectoptional
nullable
greennumberoptional
nullable
yellownumberoptional
nullable
rednumberoptional
nullable
colorSchemestringoptional
Werte
brandtableau10d3cat10okabeItoviridisbluesorangesrdYlGnsemanticpastel
nullable
colorMappingobjectoptional
nullable
sortModestringoptional
Werte
semanticlabelvalue-descvalue-asccustomnone
nullable
sortOrderstring[]optional
nullable
filtersobject[]optional
Default: []nullable
fieldstringerforderlich
operatorstringerforderlich
Werte
eqnegtgteltlteinnincontainsexists
valueanyerforderlich
refreshIntervalintegeroptional
≥ 0nullable
drillThroughobjectoptional
nullable
entityTypestringoptional
nullable
fieldMappingobjectoptional
nullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/analytics_widgets — Liste, paginiert + filterbar
  • GET /api/v1/analytics_widgets/<id> — Einzelne Entity
  • POST /api/v1/analytics_widgets — Anlegen
  • PATCH /api/v1/analytics_widgets/<id> — Teil-Update
  • DELETE /api/v1/analytics_widgets/<id> — Soft-Delete
  • GET /api/v1/analytics_widgets/<id>/timeline — Audit + Aktivitäten

Suche