Module: Metabase::Endpoint::Card

Included in:
Metabase::Endpoint
Defined in:
lib/metabase/endpoint/card.rb

Instance Method Summary collapse

Instance Method Details

#card(card_id, **params) ⇒ Hash

Fetch the card.

Parameters:

  • card_id (Integer, String) —

    Card ID

  • params (Hash) —

    Query string

Returns:

  • (Hash) —

    Parsed response JSON

See Also:



21
22
23
 
# File 'lib/metabase/endpoint/card.rb', line 21

def card(card_id, **params)
  get("/api/card/#{card_id}", **params)
end

#cards(**params) ⇒ Array<Hash>

Fetch all cards.

Parameters:

  • params (Hash) —

    Query string

Returns:

  • (Array<Hash>) —

    Parsed response JSON

See Also:



11
12
13
 
# File 'lib/metabase/endpoint/card.rb', line 11

def cards(**params)
  get('/api/card', **params)
end

#query_card(card_id, format: :json, **params) ⇒ Array<Hash>, String

Fetch query results of the card.

Parameters:

  • card_id (Integer, String) —

    Card ID

  • format (Symbol, String) (defaults to: :json) —

    Export format (csv, json, xlsx)

  • params (Hash) —

    Request body

Returns:

  • (Array<Hash>, String) —

    Query results

See Also:



42
43
44
 
# 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) ⇒ Hash

Fetch query results of the card with metadata.

Parameters:

  • card_id (Integer, String) —

    Card ID

  • params (Hash) —

    Request body

Returns:

  • (Hash) —

    Parsed response JSON

See Also:



31
32
33
 
# File 'lib/metabase/endpoint/card.rb', line 31

def query_card_with_metadata(card_id, **params)
  post("/api/card/#{card_id}/query", **params)
end