Skip to main content
POST
Schedule query

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
mode
string
required

Defines how the job writes query output to the target table. Valid values: append, overwrite, or merge.

table
string
required

The target table where the job stores results.

schema_name
string
required

The schema containing the target table.

query_id
string<uuid> | null

A unique ID of the already generated query.

merge_columns
string | null

Columns used to match and merge data. Specify only if mode is merge.

schedule
string | null

A cron expression specifying when or how often the query runs.

owner_id
string | null

The logged in user's email ID.

domain
string | null

The domain to assign to the dataset in DataHub.

tags
string[] | null

Tags to assign to the dataset in DataHub.

Response

Schedule query successful.

flow_url
string
required

Airflow URL to access the scheduled query flow.

id
string<uuid> | null

A unique ID for the scheduled query flow.

error
string | null

Error message if scheduling fails due to any issue.