Execute Malloy query

Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.

POST/environments/{environmentName}/packages/{packageName}/models/{path}/query

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

environmentName*string

Name of the environment

Match^[a-zA-Z0-9_-]+$

packageName*string

Name of the package

Match^[a-zA-Z0-9_.-]+$

path*string

Path to the model within the package

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

Request 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

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.

Defaultfalse

versionId?string

Version ID

filterParams?

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

Deprecated

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

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

Defaultfalse

givens?

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 Body

`application/json`

curl --request POST \  --url 'https://example.com/environments/string/packages/string/models/string/query' \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

{  "result": "string",  "resource": "string",  "renderLogs": [    {      "url": "string",      "range": {        "start": {          "line": 0,          "character": 0        },        "end": {          "line": 0,          "character": 0        }      },      "severity": "debug",      "message": "string"    }  ]}

Execute Malloy query

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

413application/json

500application/json

501application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`