Module: Metabase::Endpoint::Public

Included in:

Metabase::Endpoint

Defined in:

lib/metabase/endpoint/public.rb

Instance Method Summary

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

  Parsed response JSON.

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

  Query results.

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

  Parsed response JSON.

Instance Method Details

#public_card(card_uuid, **params) ⇒ Hash

Returns Parsed response JSON.

Parameters:

• Card UUID

• Query string

Returns:

• 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 11

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

Returns Query results.

Parameters:

• Card UUID

• (defaults to: :json)

  Export format (csv, json, xlsx)

• Query string

Returns:

• 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 30

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

Returns Parsed response JSON.

Parameters:

• Card UUID

• Query string

Returns:

• 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 20

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