Module: Metabase::Endpoint::Public

Included in:

Metabase::Endpoint

Defined in:

lib/metabase/endpoint/public.rb

Instance Method Summary

• #public_card(card_uuid, **params) ⇒ Hash

  Fetch the public card.

• #query_public_card(card_uuid, format: :json, **params) ⇒ Array<Hash>, String

  Fetch query results of the public card.

• #query_public_card_with_metadata(card_uuid, **params) ⇒ Hash

  Fetch query results of the public card with metadata.

Instance Method Details

#public_card(card_uuid, **params) ⇒ Hash

Fetch the public card.

Parameters:

• card_uuid (String) —

  Card UUID

• params (Hash) —

  Query string

Returns:

• (Hash) —

  Parsed response JSON

See Also:

• https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apipubliccarduuid

# File 'lib/metabase/endpoint/public.rb', line 12

def public_card(card_uuid, **params)
  get("/api/public/card/#{card_uuid}", **params)
end

#query_public_card(card_uuid, format: :json, **params) ⇒ Array<Hash>, String

Fetch query results of the public card.

Parameters:

• card_uuid (String) —

  Card UUID

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

  Export format (csv, json, xlsx)

• params (Hash) —

  Query string

Returns:

• (Array<Hash>, String) —

  Query results

See Also:

• https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apipubliccarduuidqueryexport-format

# File 'lib/metabase/endpoint/public.rb', line 33

def query_public_card(card_uuid, format: :json, **params)
  get("/api/public/card/#{card_uuid}/query/#{format}", **params)
end

#query_public_card_with_metadata(card_uuid, **params) ⇒ Hash

Fetch query results of the public card with metadata.

Parameters:

• card_uuid (String) —

  Card UUID

• params (Hash) —

  Query string

Returns:

• (Hash) —

  Parsed response JSON

See Also:

• https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#get-apipubliccarduuidquery

# File 'lib/metabase/endpoint/public.rb', line 22

def query_public_card_with_metadata(card_uuid, **params)
  get("/api/public/card/#{card_uuid}/query", **params)
end