SuperAPI AI 工具集

omni-content-explorer

编程与开发

查看项目

更新于 10-15 21:39

技能介绍

用途:通过 Omni 的 REST API 在 Omni Analytics 中查找、浏览和整理内容,包括仪表盘、工作簿、文件夹和标签,并生成可点击的内容链接。

前置配置: export OMNI_BASE_URL="https://yourorg.omniapp.co" export OMNI_API_KEY="your-api-key"

接口探测:不确定接口或参数是否存在时,可获取 OpenAPI 规范: curl -L "$OMNI_BASE_URL/openapi.json" -H "Authorization: Bearer $OMNI_API_KEY",用于确认端点、可用参数与请求/响应结构。

内容浏览:GET /api/v1/content 可列出内容,支持 include=_count,labels 返回计数与标签,支持按标签(labels=finance,marketing)、范围(scope=organization)筛选,支持按 favorites 或 updatedAt 等排序;响应含 pageInfo 游标分页,用 cursor 获取下一页。

文档:GET /api/v1/documents 列出文档,可按 creatorId 过滤,返回 identifier、name、type、scope、owner、folder、labels、updatedAt、hasDashboard 等字段。注意调用 API 时应使用 identifier 字段而非 id,workbook 类型文档的 id 为空会导致静默失败。GET /api/v1/documents/{identifier}/queries 可获取驱动仪表盘图块的查询定义,便于理解计算逻辑或用 omni-query 重跑查询。

文件夹与标签:文件夹支持列出与创建(POST /api/v1/folders,需 name 与 scope);标签支持列出,以及通过 PUT /api/v1/documents/{identifier}/labels/{labelName} 添加、DELETE 移除。收藏通过 PUT/DELETE /api/v1/documents/{identifier}/favorite 实现。

下载:POST /api/v1/dashboards/{dashboardId}/download 以 format 为 pdf 或 png 异步启动下载,再用 GET /api/v1/jobs/{jobId}/status 轮询状态。

链接与搜索:仪表盘链接为 {OMNI_BASE_URL}/dashboards/{identifier},工作簿为 {OMNI_BASE_URL}/w/{identifier},identifier 取自文档响应字段;找到内容后应给出可点击链接。扫描全部文档中的字段引用时,使用游标分页并并行调用各文档的 queries 接口;字段影响分析建议改用 omni-model-explorer 中的 content-validator 方案。

限制:资料未提供鉴权范围、速率限制、错误处理、权限要求及收费信息。