Skip to main content
POST
Execute Malloy query

Authorizations

Authorization
string
header
required

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

Path Parameters

environmentName
string
required

Name of the environment Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$
packageName
string
required

Name of the package Version identifier pattern supporting dots and dashes

Pattern: ^[a-zA-Z0-9_.-]+$
path
string
required

Path to the model within the package Path pattern supporting slashes, dots, and dashes

Pattern: ^[a-zA-Z0-9_/.-]+$

Body

application/json

Request body for executing a Malloy query

query
string

Query string to execute on the model. If the query parameter is set, the queryName parameter must be empty.

sourceName
string

Name of the source in the model to use for queryName, search, and topValue requests.

queryName
string

Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName parameter is set, the query parameter must be empty.

compactJson
boolean
default:false

If true, returns a simple JSON array of row objects in the form {"columnName": value}. If false (default), returns the full Malloy result with type metadata for rendering.

versionId
string

Version ID

filterParams
object
deprecated

DEPRECATED: Use givens (native Malloy runtime parameters) instead. Targets the deprecated #(filter) annotation path. See docs/givens.md for migration recipes.

Filter parameter values keyed by filter name. Used with sources that declare #(filter) annotations. Each value is either a string or an array of strings.

bypassFilters
boolean
default:false
deprecated

DEPRECATED: Use givens (native Malloy runtime parameters) instead. See docs/givens.md for migration recipes.

When true, skip server-side #(filter) injection entirely.

givens
object

Per-query given values that override model defaults. Keys are given names declared in the model's given: block. Values must match the declared type (string, number, boolean, date, etc.). See Malloy givens documentation for accepted value shapes.

Response

Query execution results

Results from executing a Malloy query

result
string

JSON string containing the query results, metadata, and execution information

resource
string

Resource path to the query result

renderLogs
object[]

Render tag validation messages (errors, warnings) detected during query preparation