Welcome to metabase-tools’s documentation!

• Core - MetabaseApi
  • Authentication
    • Option 1 - Username and password dictionary (recommended)
    • Option 2 - Token file
    • Option 3 - Token dictionary
  • Caching Tokens
  • Custom Session objects
  • Other Public Methods
    • Testing for successful authentication
      • test_for_auth()
    • Making generic requests
      • generic_request()
      • get()
      • delete()
      • post()
      • put()
• Basic Usage
  • Installation
  • General Use
    • Type 1 - New or grouped object methods
    • Type 2 - Single, existing object methods
• Card
  • CardItem
    • CardItem.archive()
    • CardItem.construct()
    • CardItem.copy()
    • CardItem.delete()
    • CardItem.dict()
    • CardItem.favorite()
    • CardItem.json()
    • CardItem.query()
    • CardItem.refresh()
    • CardItem.related()
    • CardItem.set_adapter()
    • CardItem.share()
    • CardItem.unarchive()
    • CardItem.unfavorite()
    • CardItem.unshare()
    • CardItem.update()
    • CardItem.update_forward_refs()
  • CardQueryResult
    • CardQueryResult.construct()
    • CardQueryResult.copy()
    • CardQueryResult.dict()
    • CardQueryResult.json()
    • CardQueryResult.update_forward_refs()
  • CardRelatedObjects
    • CardRelatedObjects.construct()
    • CardRelatedObjects.copy()
    • CardRelatedObjects.dict()
    • CardRelatedObjects.json()
    • CardRelatedObjects.update_forward_refs()
  • Cards
    • Cards.create()
    • Cards.embeddable()
    • Cards.get()
    • Cards.search()
• Collection
  • CollectionItem
    • CollectionItem.archive()
    • CollectionItem.check_for_object()
    • CollectionItem.construct()
    • CollectionItem.copy()
    • CollectionItem.delete()
    • CollectionItem.dict()
    • CollectionItem.get_contents()
    • CollectionItem.json()
    • CollectionItem.refresh()
    • CollectionItem.set_adapter()
    • CollectionItem.unarchive()
    • CollectionItem.update()
    • CollectionItem.update_forward_refs()
  • Collections
    • Collections.create()
    • Collections.get()
    • Collections.get_flat_list()
    • Collections.get_tree()
    • Collections.graph()
    • Collections.search()
• Database
  • DatabaseItem
    • DatabaseItem.archive()
    • DatabaseItem.construct()
    • DatabaseItem.copy()
    • DatabaseItem.delete()
    • DatabaseItem.dict()
    • DatabaseItem.json()
    • DatabaseItem.refresh()
    • DatabaseItem.set_adapter()
    • DatabaseItem.unarchive()
    • DatabaseItem.update()
    • DatabaseItem.update_forward_refs()
  • Databases
    • Databases.create()
    • Databases.get()
    • Databases.search()
• User
  • UserItem
    • UserItem.archive()
    • UserItem.construct()
    • UserItem.copy()
    • UserItem.delete()
    • UserItem.dict()
    • UserItem.disable()
    • UserItem.enable()
    • UserItem.json()
    • UserItem.qbnewb()
    • UserItem.refresh()
    • UserItem.resend_invite()
    • UserItem.set_adapter()
    • UserItem.unarchive()
    • UserItem.update()
    • UserItem.update_forward_refs()
    • UserItem.update_password()
  • Users
    • Users.create()
    • Users.current()
    • Users.get()
    • Users.search()
• Tools
• Exceptions
  • MetabaseApiException

Indices

• Index

• Module Index