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

Returns Parsed response JSON.

Parameters:

  • card_id (Integer, String) —

    Card ID

  • params (Hash) —

    Query string

Returns:

  • (Hash) —

    Parsed response JSON

See Also:



19
20
21
 
# File 'lib/metabase/endpoint/card.rb', line 19

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

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

Returns Parsed response JSON.

Parameters:

  • params (Hash) —

    Query string

Returns:

  • (Array<Hash>) —

    Parsed response JSON

See Also:



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

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

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

Returns Query results.

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:



38
39
40
 
# File 'lib/metabase/endpoint/card.rb', line 38

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

Returns Parsed response JSON.

Parameters:

  • card_id (Integer, String) —

    Card ID

  • params (Hash) —

    Request body

Returns:

  • (Hash) —

    Parsed response JSON

See Also:



28
29
30
 
# File 'lib/metabase/endpoint/card.rb', line 28

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