Metabase Datasets API

Execute ad-hoc queries against connected databases.

OpenAPI Specification

metabase-datasets-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Metabase Cards Datasets API
  description: The Metabase API provides programmatic access to Metabase, an open source business intelligence and analytics platform. It allows developers to manage dashboards, questions (cards), collections, databases, users, permissions, and to execute queries against connected data sources.
  version: '1.0'
  contact:
    name: Metabase
    url: https://www.metabase.com
  license:
    name: AGPL-3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
servers:
- url: https://your-metabase-instance.com/api
  description: Self-hosted or cloud Metabase instance
security:
- ApiKeyAuth: []
- SessionAuth: []
tags:
- name: Datasets
  description: Execute ad-hoc queries against connected databases.
paths:
  /dataset:
    post:
      tags:
      - Datasets
      summary: Execute an ad-hoc query
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                database:
                  type: integer
                type:
                  type: string
                  enum:
                  - query
                  - native
                native:
                  type: object
                  properties:
                    query:
                      type: string
      responses:
        '200':
          description: Query result.
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
    SessionAuth:
      type: apiKey
      in: header
      name: X-Metabase-Session