Alerts

Generate SQL from alert query parameters

Generates a SQL query string based on alert query parameters including stream, aggregations, and conditions. This endpoint is useful for testing alert queries and understanding the SQL that will be executed.

post/api/v2/{org_id}/alerts/generate_sql

Request

Base URL
https://api.openobserve.ai (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/openobserve/apis/openobserve-api-http/docs/api/v2/:org_id/alerts/generate_sql/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

org_idstring required

Organization name

Request body

stream_namestring required

Stream name to query

Example request

{
  "stream_name": "default"
}

Response

Success

sqlstring required

The generated SQL query string

Example response

{
  "sql": "SELECT * FROM \"my_stream\" WHERE field > 100"
}

Changes

No recorded changes to this operation across all 1 revision of this API.