module Metabase::Endpoint::Public

Public Instance Methods

public_card(card_uuid, **params) click to toggle source

Fetch the public card.

@param card_uuid [String] Card UUID @param params [Hash] Query string @return [Hash] Parsed response JSON @see 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) click to toggle source

Fetch query results of the public card.

@param card_uuid [String] Card UUID @param format [Symbol, String] Export format (csv, json, xlsx) @param params [Hash] Query string @return [Array<Hash>, String] Query results @see 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) click to toggle source

Fetch query results of the public card with metadata.

@param card_uuid [String] Card UUID @param params [Hash] Query string @return [Hash] Parsed response JSON @see 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