Skip to main content
POST
Schedule a query/card

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

A user-defined name for the scheduled query job.

cron
string
required

A cron expression defining when or how often the query should run.

card_url
string | null

URL of the card or visualization you want to schedule.

query_id
string<uuid> | null

Unique ID of the query you want to schedule.

Response

Query scheduled successfully.

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.