MEmetabase
/api/agent

POST /api/agent/v1/execute

Changed on

Execute an MBQL query and return results.

Accepts a base64-encoded MBQL query (as returned by /v1/construct-query) and executes it, returning results with column metadata.

Response format:

  • On success: {:data {:cols [...] :rows [...]} :row_count N :status :completed :running_time M}
  • On failure: {:status :failed :error "message" ...}

Standard userspace query limits are enforced (2000 rows for simple queries, 10000 for aggregated).

post/api/agent/v1/execute

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Request body

querystring required

value must be a non-blank string.

Response

Successful response

errorstring
row_countinteger
running_timeinteger
status'completed' | 'failed' required

Changes

  • 2e178f5a7934Revision changes
    • info

      added subschema #1 subschema #2 to the /// response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the /// response property oneOf list for the response status

  • 78297d193ca4Revision changes
    • info

      endpoint added