Run a query
Execute a query and return its result rows. Served by a custom handler (not generated), so this operation intentionally carries no x-ctrl-hub domain tag; it exists in the spec so the operation middleware admits the path.
Authorizations
Session token for authentication.
Path Parameters
The unique identifier for the query.
Query Parameters
Limit the number of resources returned by the API
x >= 1Offset the resources returned by the API
x >= 0Optional created_at range operator AND-ed onto the query as an additional constraint (a dashboard's global date range applied to a card). Relative presets (today, yesterday, last_n_days, this_week, this_month, this_quarter, this_year) are resolved live against the fixed Europe/London timezone at run time, including DST-sensitive boundaries; between/before/after take concrete bound(s). Omit for no additional constraint. Pair with date_values when the operator needs parameters.
today, yesterday, last_n_days, this_week, this_month, this_quarter, this_year, between, before, after Parameter values for date_op (e.g. 30 for last_n_days, or the two ends of a between). Repeat the parameter for multiple values. Ignored when date_op is absent.
Response
The query result rows, as a JSON:API collection of query-result-rows (dynamic attributes, with column descriptors and pagination in meta).
The response is of type object.