Skip to main content
POST

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json
sourceId
string
必填

Source ID to query. Call GET /api/v2/sources to list available sources. The source determines the underlying ClickHouse table (e.g. otel.otel_logs, otel.otel_traces) and its column schema.

示例:

"69b46cb0d964ce2d0b9506a8"

startTime
string<date-time>

Start of the query window (ISO 8601). Defaults to 15 minutes before endTime. Must be before endTime.

示例:

"2026-05-10T00:00:00Z"

endTime
string<date-time>

End of the query window (ISO 8601). Defaults to now.

示例:

"2026-05-10T01:00:00Z"

where
string
默认值:""

Row filter expression. The language is controlled by whereLanguage.

Lucene examples (default): SeverityText:ERROR pipedream.pipeline_name:my-pipeline AND SeverityText:ERROR Body:timeout

SQL examples (whereLanguage: "sql"): SeverityText = 'ERROR' pipedream.pipeline_name = 'my-pipeline'

Maximum string length: 8192
示例:

"SeverityText:ERROR"

whereLanguage
enum<string>
默认值:lucene

Language used for the where filter. Default is lucene.

可用选项:
lucene,
sql
示例:

"lucene"

select
string
默认值:""

Comma-separated list of ClickHouse column expressions to include in each result row. When omitted the source's default select expression is used.

Each entry is a ClickHouse SQL expression executed under the team's database user. Semicolons and subqueries (SELECT keyword) are rejected; use column references, map lookups, or function calls only.

HyperDX rewrites known attribute column names to their materialized equivalents automatically; you can still pass the logical name.

Maximum string length: 4096
示例:

"Timestamp,SeverityText,Body,pipedream.pipeline_name"

orderBy
string

ClickHouse ORDER BY expression. When omitted the source's default ordering (typically timestamp DESC) is used.

Maximum string length: 1024
示例:

"Timestamp DESC"

maxResults
integer
默认值:100

Maximum number of rows to return. Default is 100, max is 2000.

必填范围: 1 <= x <= 2000
offset
integer
默认值:0

Number of rows to skip (best-effort offset pagination). Default is 0, max is 10000. Offset pagination is non-deterministic when multiple rows share the same timestamp; for reliable deep paging filter by the last Timestamp value returned in the previous page instead of using a large offset.

必填范围: 0 <= x <= 10000

响应

Matching rows returned successfully

data
object[]

Array of result rows. Each row is an object with keys corresponding to the requested columns.

rows
integer

Number of rows in this response (not total matching rows).

最后修改于 2026年7月16日