AI-DaaS API (0.1.0)

Download OpenAPI specification:Download

统一数据查询、指标查询与视图查询接口规范。

健康检查

Responses

Response samples

200

Content type

application/json

{"status": "OK"
}

执行查询（QueryController）

Authorizations:

bearerAuth

header Parameters

X-Tenant-Id

required

string

目标租户标识

Request Body schema: application/json
required

entity required	string 查询目标实体或视图名
required	Array of objects (SelectItem)
	object or object (Filter)
	object (TimeConfig)
limit	integer Default: 100
offset	integer Default: 0

Responses

Request samples

Payload

Content type

application/json

{"entity": "orders",
"select": [{"field": "date",
"alias": "date"
},
{"field": "amount",
"agg": "SUM",
"alias": "revenue"
}
],
"filter": {"op": "AND",
"conditions": [{"field": "status",
"op": "EQ",
"value": "PAID"
},
{"field": "country",
"op": "IN",
"value": ["US",
"CA"
]
}
]
},
"time": {"granularity": "DAY",
"range": {"from": "2024-09-01",
"to": "2024-09-30"
}
},
"limit": 100,
"offset": 0
}

Response samples

200

Content type

application/json

{"success": true,
"data": {"columns": ["date",
"revenue"
],
"rows": [["2024-09-01",
1200.5
]
]
}
}

验证查询 DSL

Authorizations:

bearerAuth

Request Body schema: application/json
required

entity required	string 查询目标实体或视图名
required	Array of objects (SelectItem)
	object or object (Filter)
	object (TimeConfig)
limit	integer Default: 100
offset	integer Default: 0

Responses

Request samples

Payload

Content type

application/json

{"entity": "orders",
"select": [{"field": "amount",
"agg": "SUM"
}
]
}

Response samples

200

Content type

application/json

{"success": true,
"data": true
}

解释计划

Authorizations:

bearerAuth

header Parameters

X-Tenant-Id

required

string

目标租户标识

Request Body schema: application/json
required

entity required	string 查询目标实体或视图名
required	Array of objects (SelectItem)
	object or object (Filter)
	object (TimeConfig)
limit	integer Default: 100
offset	integer Default: 0

Responses

Request samples

Payload

Content type

application/json

{"entity": "string",
"select": [{"field": "string",
"agg": "string",
"alias": "string"
}
],
"filter": {"field": "string",
"op": "EQ",
"value": null
},
"time": {"granularity": "HOUR",
"range": {"from": "2024-09-01",
"to": "2024-09-30"
}
},
"limit": 100,
"offset": 0
}

Response samples

200

Content type

application/json

{"success": true,
"data": "Seq Scan on orders..."
}

单指标查询（MetricQueryController）

Authorizations:

bearerAuth

path Parameters

metricName

required

string

header Parameters

X-Tenant-Id

required

string

目标租户标识

Request Body schema: application/json
required

dimensions	Array of strings
	object or object (Filter)
	object (TimeConfig)
limit	integer
offset	integer

Responses

Request samples

Payload

Content type

application/json

{"dimensions": ["channel"
],
"filter": {"op": "AND",
"conditions": [{"field": "country",
"op": "EQ",
"value": "US"
},
{"field": "status",
"op": "EQ",
"value": "PAID"
}
]
},
"time": {"granularity": "DAY",
"range": {"from": "2024-09-01",
"to": "2024-09-30"
}
},
"limit": 50
}

Response samples

200

Content type

application/json

{"success": true,
"data": {"columns": ["channel",
"revenue"
],
"rows": [["web",
5000
],
["store",
3000
]
]
}
}

批量指标查询

Authorizations:

bearerAuth

header Parameters

X-Tenant-Id

required

string

目标租户标识

Request Body schema: application/json
required

metrics required	Array of strings
	object (MetricQueryParams)

Responses

Request samples

Payload

Content type

application/json

{"metrics": ["revenue",
"orders_count"
],
"params": {"dimensions": ["channel"
],
"limit": 10
}
}

Response samples

200

Content type

application/json

{"success": true,
"data": {"revenue": {"columns": ["channel",
"revenue"
],
"rows": [["web",
5000
]
]
},
"orders_count": {"columns": ["channel",
"orders_count"
],
"rows": [["web",
120
]
]
}
}
}

根据视图名称执行查询（ViewController）

Authorizations:

bearerAuth

path Parameters

viewName

required

string

header Parameters

X-Tenant-Id

required

string

目标租户标识

Request Body schema: application/json
required

	object
	object (TimeConfig)
limit	integer
offset	integer

Responses

Request samples

Payload

Content type

application/json

{"params": {"country": "US",
"channel": "web"
},
"time": {"granularity": "DAY",
"range": {"from": "2024-09-01",
"to": "2024-09-30"
}
},
"limit": 100
}

Response samples

200
400

Content type

application/json

{"success": true,
"data": {"columns": ["date",
"revenue"
],
"rows": [["2024-09-01",
1200.5
]
]
}
}

AI-DaaS API (0.1.0)

健康检查

Responses

Response samples

执行查询（QueryController）

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

验证查询 DSL

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

解释计划

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

单指标查询（MetricQueryController）

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

批量指标查询

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

根据视图名称执行查询（ViewController）

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required