用途:通过 Omni REST API 以编程方式创建、更新和管理 Omni 文档与仪表板,涵盖文档生命周期、工作簿模型、筛选器和仪表板内容。可配合 omni-model-explorer 了解字段、omni-content-explorer 查找既有仪表板。
主要能力:文档的创建(仅命名或含查询与可视化)、重命名、删除(软删除)、移动、复制;更新既有仪表板的图块、查询、筛选器与可视化;通过工作簿模型推送自定义维度与度量;管理仪表板筛选器。
使用方式:先设置环境变量:export OMNI_BASE_URL="https://yourorg.omniapp.co" 和 export OMNI_API_KEY="your-api-key"。用 GET "$OMNI_BASE_URL/openapi.json" 核对端点与参数。创建文档用 POST /api/v1/documents,更新用 PUT /api/v1/documents/{documentId}(整体替换),移动用 PUT .../move,复制用 POST .../duplicate。所有文档 API 调用使用 identifier 而非 id。
限制与默认:创建仪表板前先通过 POST /api/v1/query/run 测试每个查询;每个查询至少包含一个度量;默认 chartType 用 "table";prefersChart 必须为 true 才渲染图表;visType 用 "omni-kpi" 或 "basic";文档未提供具体收费、价格和平台信息。部分端点可能未出现在 OpenAPI 规范中。