module Metabase::Endpoint::Card

Public Instance Methods

card(card_id, **params) click to toggle source

Fetch the card.

@param card_id [Integer, String] Card ID @param params [Hash] Query string @return [Hash] Parsed response JSON @see github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apicardid

# File lib/metabase/endpoint/card.rb, line 21
def card(card_id, **params)
  get("/api/card/#{card_id}", **params)
end
cards(**params) click to toggle source

Fetch all cards.

@param params [Hash] Query string @return [Array<Hash>] Parsed response JSON @see github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apicard

# File lib/metabase/endpoint/card.rb, line 11
def cards(**params)
  get('/api/card', **params)
end
query_card(card_id, format: :json, **params) click to toggle source

Fetch query results of the card.

@param card_id [Integer, String] Card ID @param format [Symbol, String] Export format (csv, json, xlsx) @param params [Hash] Request body @return [Array<Hash>, String] Query results @see github.com/metabase/metabase/blob/master/docs/api-documentation.md#post-apicardcard-idqueryexport-format

# File lib/metabase/endpoint/card.rb, line 42
def query_card(card_id, format: :json, **params)
  post("/api/card/#{card_id}/query/#{format}", **params)
end
query_card_with_metadata(card_id, **params) click to toggle source

Fetch query results of the card with metadata.

@param card_id [Integer, String] Card ID @param params [Hash] Request body @return [Hash] Parsed response JSON @see github.com/metabase/metabase/blob/master/docs/api-documentation.md#post-apicardcard-idquery

# File lib/metabase/endpoint/card.rb, line 31
def query_card_with_metadata(card_id, **params)
  post("/api/card/#{card_id}/query", **params)
end