Quasar 官网 · 产品介绍 · 参考
参考 · 接口

API & 数据表

SQL Engine / ID-Mapping / Assistant 三服务完整接口目录（254+ 接口，24 个域）+ 调用约定 + 核心数据表。

调用约定

控制台全部经 Nginx 网关 :8080 访问；SQL Engine 的接口统一挂在 /api/* 前缀下（网关剥离 /api 后转发）。

服务网关路径直连端口
SQL Engine（CDP 主体）/api/*:8002
ID-Mapping（OneID）/ID-Mapping/*:8001
智能助手 Assistant/assistant/*:8004
  • 多租户：几乎所有接口都需 tenant_id（路径参数或请求体），按租户强制隔离。
  • 鉴权：先 POST /api/auth/login 拿 token，后续请求携带；网关在 http 层统一注入鉴权头。
  • 安全边界：圈人 / 查询永不直出 SQL —— 走模板（/api/query/*）或 DSL 校验链（/api/dsl/*）。
  • Swagger：SQL Engine · ID-Mapping（在线交互式文档，含请求/响应模型）。
鉴权 Auth查询与模板 Query圈人 DSL（安全边界）自然语言圈人 & 受众群组 Groups标签 Tags对象 ObjectsETL 导入统一 Unify连接 Connections调度 Scheduler（Airflow）触达 Engage客户 Accounts分析 Analyst语义层 Semantic知识库 Knowledge应用 Apps监控 Monitor协议 Protocols隐私 Privacy平台 Platform设置 / IAMID-Mapping 服务智能助手 Assistant

快速上手示例

# 1) 登录拿 token
curl -X POST http://localhost:8080/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"admin@acme.com","password":"demo123"}'

# 2) 模板查询：按 OneID 查画像宽表
curl -X POST http://localhost:8080/api/query/profile_by_one_id \
  -H "Content-Type: application/json" \
  -d '{"params":{"tenant_id":1001,"one_id":100001}}'

# 3) 自然语言查询
curl -X POST http://localhost:8080/api/nl-query \
  -H "Content-Type: application/json" \
  -d '{"question":"查手机号13800138001的用户画像","tenant_id":1001}'

# 4) DSL 圈人：校验 → 预估人数（不执行 SQL）
curl -X POST http://localhost:8080/api/dsl/estimate \
  -H "Content-Type: application/json" \
  -d '{"tenant_id":1001,"rule":{"object":"user","logic":"AND","conditions":[],"relations":[]}}'

# 5) 自然语言圈人 → 候选 DSL（已过校验层）
curl -X POST http://localhost:8080/api/agent/segment/draft \
  -H "Content-Type: application/json" \
  -d '{"question":"近30天下过单且客单价大于500的用户","tenant_id":1001}'

# 6) 渠道 → OneID 映射 / 合并日志（ID-Mapping）
curl http://localhost:8080/ID-Mapping/mapping/1001/phone/13900001111
curl http://localhost:8080/ID-Mapping/merge-log/1001

接口总览 · 共 254+ 接口 / 24 个域

下表为 SQL Engine / ID-Mapping / Assistant 三服务的完整接口目录。完整请求/响应模型见各服务 Swagger。

鉴权 Auth · 2 个接口

SQL Engine · /api
方法路径说明
POST/api/auth/login邮箱 + 密码登录，返回 token、用户与所属租户
GET/api/auth/me当前登录用户与租户上下文

查询与模板 Query · 5 个接口

SQL Engine · /api
方法路径说明
GET/api/health健康检查（含 NL 查询能力开关）
GET/api/templates列出可用的命名模板查询
POST/api/query/{template_name}执行命名模板查询（参数绑定，绝不拼 SQL）
GET/api/query/{template_name}同上，查询参数形式
POST/api/nl-query自然语言 → 模板查询（DeepSeek 意图识别）

圈人 DSL（安全边界） · 4 个接口

SQL Engine · /api
方法路径说明
POST/api/dsl/validate校验 DSL 规则：字段 / 操作符 / 关系 / 跳数
POST/api/dsl/echoDSL → 中文可读摘要
POST/api/dsl/compileDSL → SQL（仅编译，不执行）
POST/api/dsl/estimateDSL 干跑 COUNT，预估人数

自然语言圈人 & 受众 · 5 个接口

SQL Engine · /api
方法路径说明
POST/api/agent/segment/draft自然语言 → 候选 DSL（已过校验层）
POST/api/agent/segment/confirm人工确认后保存为受众
POST/api/segments保存受众
GET/api/segments/{tenant_id}受众列表
GET/api/segments/{tenant_id}/{segment_code}受众详情

群组 Groups · 10 个接口

SQL Engine · /api
方法路径说明
POST/api/groups创建用户群组
POST/api/groups/search搜索群组
GET/api/groups/{tenant_id}群组列表
GET/api/groups/{tenant_id}/{group_id}群组详情
GET/api/groups/{tenant_id}/code/{group_code}按编码取群组
GET/api/groups/{tenant_id}/{group_id}/members群组成员
POST/api/groups/{tenant_id}/{group_id}/members加入成员
DELETE/api/groups/{tenant_id}/{group_id}/members/{one_id}移除成员
GET/api/users/{tenant_id}/{one_id}用户画像
GET/api/users/{tenant_id}/{one_id}/groups用户所属群组

标签 Tags · 8 个接口

SQL Engine · /api
方法路径说明
POST/api/tags创建标签
POST/api/tags/search搜索标签
GET/api/tags/{tenant_id}标签列表
GET/api/tags/{tenant_id}/tree标签树（层级）
GET/api/tags/{tenant_id}/code/{tag_code}/count标签覆盖人数
POST/api/unify/tags/{tenant_id}/{code}/assign给对象打标签
DELETE/api/unify/tags/{tenant_id}/{code}/object/{object_type}/{object_id}取消对象标签
GET/api/unify/object-tags/{tenant_id}/{object_type}/{object_id}对象已打标签

对象 Objects · 13 个接口

SQL Engine · /api
方法路径说明
GET/api/objects/meta对象注册表（对象 / 字段 / 关系矩阵）
POST/api/objects/upsertupsert 对象记录
POST/api/objects/relations建立对象关系
POST/api/objects/search跨对象多跳筛选查询
GET/api/metadata/{tenant_id}/fields可筛选字段元数据
GET/api/objects/{tenant_id}/definitions对象定义
POST/api/objects/create新建对象类型
POST/api/objects/{tenant_id}/relations新增关系定义
DELETE/api/objects/{tenant_id}/relations/{src_type}/{rel_type}/{dst_type}删除关系定义
POST/api/objects/{tenant_id}/{object_key}/fields新增字段
PATCH/api/objects/{tenant_id}/{object_key}/fields/{field_code}修改字段
GET/api/objects/{tenant_id}/{object_key}/{pk_value}记录详情
GET/api/objects/{tenant_id}/{object_key}/{pk_value}/relations记录的关联

ETL 导入 · 3 个接口

SQL Engine · /api
方法路径说明
POST/api/etl/preview字段映射 / 类型强转 / 校验预览
POST/api/etl/import导入到目标对象（可同时建关系）
POST/api/users/import批量导入用户

统一 Unify · 14 个接口

SQL Engine · /api
方法路径说明
GET/api/unify/identity-rules/{tenant_id}身份解析规则
POST/api/unify/identity-rules/{tenant_id}新增 / 更新规则
DELETE/api/unify/identity-rules/{tenant_id}/{rule_id}删除规则
GET/api/unify/groups/{tenant_id}群组列表（Unify 视角）
POST/api/unify/groups/{tenant_id}/{group_id}/refresh重算群组人数
POST/api/unify/sql-traits/{tenant_id}创建 SQL 特征
GET/api/unify/sql-traits/{tenant_id}SQL 特征列表
POST/api/unify/sql-traits/{tenant_id}/{trait_id}/execute执行某 SQL 特征
POST/api/unify/sql-traits/{tenant_id}/execute执行全部 SQL 特征
POST/api/unify/predictions/{tenant_id}创建预测模型
GET/api/unify/predictions/{tenant_id}预测模型列表
POST/api/unify/predictions/{tenant_id}/{model_id}/infer推理打分
POST/api/unify/profiles/sync/{tenant_id}档案同步回数仓
POST/api/unify/objects/search带标签的对象检索

连接 Connections · 27 个接口

SQL Engine · /api
方法路径说明
GET/api/connections/sources数据源列表
POST/api/connections/sources创建数据源
GET/api/connections/sources/{source_id}数据源详情
POST/api/connections/sources/{source_id}/test连通性测试
GET/api/connections/sources/{source_id}/events数据源事件流
POST/api/connections/events/track上报事件
GET/api/connections/destinations目的地列表
POST/api/connections/destinations创建目的地
GET/api/connections/destinations/{destination_id}目的地详情
POST/api/connections/destinations/{destination_id}/test测试目的地
POST/api/connections/destinations/{destination_id}/mappings保存字段映射
GET/api/connections/reverse-etl/jobsReverse ETL 任务列表
POST/api/connections/reverse-etl/jobs创建 Reverse ETL 任务
GET/api/connections/reverse-etl/jobs/{job_id}/runs运行记录
POST/api/connections/reverse-etl/jobs/{job_id}/run-now立即运行
POST/api/connections/reverse-etl/runs/{run_id}/complete运行完成回调
GET/api/connections/warehouses数据仓库列表
POST/api/connections/warehouses连接数仓
POST/api/connections/warehouses/{warehouse_id}/sync触发同步
GET/api/connections/functionsFunctions 列表
POST/api/connections/functions创建 Function
POST/api/connections/functions/{function_id}/deploy部署 Function
GET/api/connections/functions/{function_id}/runs运行记录
GET/api/connections/pipelines管道列表
POST/api/connections/pipelines保存管道
GET/api/connections/pipelines/{pipeline_id}管道详情
POST/api/connections/pipelines/{pipeline_id}/execute执行管道（触发 Airflow DAG）

调度 Scheduler（Airflow） · 4 个接口

SQL Engine · /api
方法路径说明
GET/api/connections/scheduler/healthAirflow 连通性 + DAG 状态
POST/api/connections/scheduler/pause暂停 / 恢复调度
GET/api/connections/scheduler/runs全局运行状态（最近 N 次）
GET/api/connections/pipelines/{pipeline_id}/runs某管道执行历史

触达 Engage · 19 个接口

SQL Engine · /api
方法路径说明
POST/api/engage/estimate-audience受众规模预估
GET/api/engage/journeys旅程列表
POST/api/engage/journeys创建旅程
GET/api/engage/journeys/{journey_id}旅程详情
PUT/api/engage/journeys/{journey_id}更新旅程
DELETE/api/engage/journeys/{journey_id}删除旅程
POST/api/engage/journeys/{journey_id}/status设置旅程状态
GET/api/engage/journeys/{journey_id}/steps旅程步骤
PUT/api/engage/journeys/{journey_id}/steps替换步骤
GET/api/engage/journeys/{journey_id}/state旅程运行态
GET/api/engage/journeys/{journey_id}/stats旅程统计
GET/api/engage/broadcasts群发列表
POST/api/engage/broadcasts创建群发
GET/api/engage/broadcasts/{broadcast_id}群发详情
PUT/api/engage/broadcasts/{broadcast_id}更新群发
DELETE/api/engage/broadcasts/{broadcast_id}删除群发
POST/api/engage/broadcasts/{broadcast_id}/send发送群发
GET/api/engage/broadcasts/{broadcast_id}/sends发送明细
GET/api/engage/broadcasts/{broadcast_id}/stats群发统计

客户 Accounts · 11 个接口

SQL Engine · /api
方法路径说明
GET/api/accounts客户列表
POST/api/accounts/search客户检索
GET/api/accounts/{account_id}客户详情
GET/api/accounts/{account_id}/users客户下的用户
GET/api/accounts/{account_id}/aggregates客户聚合指标
PUT/api/accounts/{account_id}/aggregates写入聚合指标
GET/api/accounts/{account_id}/hierarchy客户层级
PUT/api/accounts/{account_id}/hierarchy写入层级
GET/api/accounts/{account_id}/merge-log客户合并日志
GET/api/accounts/-/merge-log全部合并日志
POST/api/accounts/merge合并客户

分析 Analyst · 14 个接口

SQL Engine · /api
方法路径说明
GET/api/analyst/sources白名单数据源目录（NL 选图用）
GET/api/analyst/data图表数据（安全聚合）
GET/api/analyst/drilldown图表数据点下钻明细
GET/api/analyst/kpisKPI 卡数据
GET/api/analyst/charts图表列表
POST/api/analyst/charts保存图表
DELETE/api/analyst/charts/{cid}删除图表
POST/api/analyst/charts/nl自然语言生成图表
GET/api/analyst/dashboards看板列表
GET/api/analyst/dashboards/{did}看板详情
POST/api/analyst/dashboards保存看板
PUT/api/analyst/dashboards/{did}更新看板
DELETE/api/analyst/dashboards/{did}删除看板
POST/api/analyst/dashboards/nl自然语言生成看板

语义层 Semantic · 2 个接口

SQL Engine · /api
方法路径说明
GET/api/semantic/metrics指标目录（口径定义）
GET/api/semantic/metrics/values指标取值

知识库 Knowledge · 8 个接口

SQL Engine · /api
方法路径说明
POST/api/kb/files上传文件（多模态）
GET/api/kb/files文件列表（搜索 / 类型筛选）
GET/api/kb/folders虚拟目录
GET/api/kb/files/{fid}文件详情
GET/api/kb/files/{fid}/download下载文件
DELETE/api/kb/files/{fid}删除文件
POST/api/kb/files/{fid}/links关联到对象记录
DELETE/api/kb/files/{fid}/links/{link_id}解除关联

应用 Apps · 3 个接口

SQL Engine · /api
方法路径说明
GET/api/apps应用市场列表 + 连接状态
POST/api/apps/{app_key}连接 / 配置应用
DELETE/api/apps/{app_key}断开应用

监控 Monitor · 18 个接口

SQL Engine · /api
方法路径说明
GET/api/monitor/overview投递概览
GET/api/monitor/metrics指标列表
POST/api/monitor/metrics写入指标
GET/api/monitor/sources数据源健康
GET/api/monitor/delivery-logs投递日志
POST/api/monitor/delivery-logs写入投递日志
GET/api/monitor/delivery-stats投递统计
GET/api/monitor/alert-rules告警规则列表
POST/api/monitor/alert-rules创建告警规则
GET/api/monitor/alert-rules/{rule_id}规则详情
PUT/api/monitor/alert-rules/{rule_id}更新规则
DELETE/api/monitor/alert-rules/{rule_id}删除规则
POST/api/monitor/alert-rules/{rule_id}/evaluate评估规则
GET/api/monitor/alert-events告警事件列表
POST/api/monitor/alert-events创建告警事件
GET/api/monitor/alert-events/{event_id}事件详情
POST/api/monitor/alert-events/{event_id}/acknowledge确认告警
POST/api/monitor/alert-events/{event_id}/resolve解决告警

协议 Protocols · 18 个接口

SQL Engine · /api
方法路径说明
GET/api/protocols/tracking-plans埋点计划列表
POST/api/protocols/tracking-plans创建埋点计划
GET/api/protocols/tracking-plans/{plan_id}计划详情
PUT/api/protocols/tracking-plans/{plan_id}更新计划
DELETE/api/protocols/tracking-plans/{plan_id}删除计划
GET/api/protocols/tracking-plans/{plan_id}/events计划内事件
POST/api/protocols/tracking-plans/{plan_id}/events新增事件 Schema
PUT/api/protocols/tracking-plans/events/{event_id}更新事件 Schema
DELETE/api/protocols/tracking-plans/events/{event_id}删除事件 Schema
POST/api/protocols/tracking-plans/{plan_id}/validate按计划校验事件
GET/api/protocols/violations违规列表
POST/api/protocols/violations上报违规
DELETE/api/protocols/violations/{violation_id}删除违规
GET/api/protocols/transformations转换规则列表
POST/api/protocols/transformations创建转换规则
GET/api/protocols/transformations/{tf_id}转换详情
PUT/api/protocols/transformations/{tf_id}更新转换
DELETE/api/protocols/transformations/{tf_id}删除转换

隐私 Privacy · 16 个接口

SQL Engine · /api
方法路径说明
POST/api/privacy/pii/scanPII 检测扫描
GET/api/privacy/pii/rulesPII 规则列表
POST/api/privacy/pii/rules创建 PII 规则
PUT/api/privacy/pii/rules/{rule_id}更新 PII 规则
DELETE/api/privacy/pii/rules/{rule_id}删除 PII 规则
GET/api/privacy/consent/categories同意分类
POST/api/privacy/consent/categories创建同意分类
PUT/api/privacy/consent/categories/{category_id}更新同意分类
POST/api/privacy/consent记录同意
GET/api/privacy/consent/{one_id}查询用户同意
GET/api/privacy/deletion删除请求列表
POST/api/privacy/deletion创建删除请求（GDPR）
POST/api/privacy/deletion/{request_id}/execute执行删除
GET/api/privacy/deletion/{request_id}删除请求详情
GET/api/privacy/suppression/check抑制名单检查
POST/api/privacy/audit/logs查询审计日志

平台 Platform · 9 个接口

SQL Engine · /api
方法路径说明
GET/api/platform/infra-stats基础设施统计
GET/api/platform/tenants租户列表
POST/api/platform/tenants创建租户
GET/api/platform/tenants/{tenant_id}租户详情
PUT/api/platform/tenants/{tenant_id}更新租户
PATCH/api/platform/tenants/{tenant_id}切换租户状态
GET/api/platform/tenants/{tenant_id}/config租户配置
PUT/api/platform/tenants/{tenant_id}/config更新租户配置
GET/api/platform/audit/tenant-config租户配置变更审计

设置 / IAM · 23 个接口

SQL Engine · /api
方法路径说明
GET/api/tenants/{tenant_id}工作区信息
PATCH/api/tenants/{tenant_id}更新工作区
GET/api/iam/users成员列表
POST/api/iam/users新增成员（即登录账号）
PATCH/api/iam/users/{user_id}更新成员
DELETE/api/iam/users/{user_id}删除成员
GET/api/iam/roles角色列表
POST/api/iam/roles创建角色
PATCH/api/iam/roles/{role_id}更新角色
DELETE/api/iam/roles/{role_id}删除角色
GET/api/iam/teams团队列表
POST/api/iam/teams创建团队
POST/api/iam/teams/{team_id}/members加入团队成员
DELETE/api/iam/teams/{team_id}/members/{user_id}移除团队成员
GET/api/iam/invitations邀请列表
POST/api/iam/invitations创建邀请
POST/api/iam/invitations/{token}/accept接受邀请
DELETE/api/iam/invitations/{invitation_id}取消邀请
GET/api/iam/tokensAPI 令牌列表
POST/api/iam/tokens签发令牌
DELETE/api/iam/tokens/{token_id}吊销令牌
GET/api/iam/audit审计日志
POST/api/iam/audit写入审计

ID-Mapping 服务 · 8 个接口

ID-Mapping · :8001 或网关 /ID-Mapping/*
方法路径说明
GET/health健康检查
POST/events/process处理 UserEvent（实时合并）
POST/users/import批量导入用户
GET/mapping/{tenant_id}/{channel_type}/{channel_id}渠道 ID → OneID 映射
GET/profile/{tenant_id}/{one_id}按 OneID 查画像
GET/wide/query/{tenant_id}宽表查询
GET/wide/{tenant_id}/{one_id}按 OneID 查宽表
GET/merge-log/{tenant_id}合并审计日志

智能助手 Assistant · 10 个接口

Assistant · :8004 或网关 /assistant/*
方法路径说明
GET/health健康检查
GET/agents智能体清单
GET/mcp/tools可调用的 MCP 工具清单
POST/chat对话（路由 → 专职智能体）
GET/conversations会话列表
GET/history历史消息
DELETE/history清空历史
GET/tasks后台任务列表
GET/tasks/{run_id}任务详情
POST/observe埋点观测（主动式 Copilot）

核心数据表

表用途
tenants租户配置
id_mapping渠道 ID → OneID
user_profile / doris_user_wide画像 / 宽表
object_*客户 / 订单 / 商品 / 门店
user_groups / segments受众
merge_log合并审计
← 上一页常见问答 FAQ