Shimoku docs
Search…
Managing Suites (Apps)
A business has a set of suites, tecnically called apps that can be viewed by an admin user and an unlimited number of viewer users. Managing businesses with Shimoku's SDK goes as follows:
The shimoku.app object has the following methods:
  • get_app(business_id: str, app_id: str) to create suite data
  • get_app_by_type(business_id: str, app_type_id: str)
  • get_app_path_names(business_id: str, app_id: str) to retrieve in cascade all paths that belong to a suite (see here)
  • get_app_reports(business_id: str, app_id: str) to retrieve in cascade all reports that belong to a suite (see here)
  • has_app_report(business_id: str, app_id: str)
  • show_title(business_id: str, app_id: str)
  • hide_title(business_id: str, app_id: str)
  • create_app(business_id: str, app_type_id: str) to create a new suite in a business
  • update_app(business_id: str, app_id str, app_data: Dict) to update the data of a suite.
  • delete_app(business_id: str, app_id: str) to delete permanently a suite in cascade with all the paths and reports.

get_app

app_data: Dict[str, Any] = shimoku.app.get_app(app_id)
That returns a dictionary such as:
app_data = {
'id': 'f74gh9', # app uuid
'appType': 'ee331' # appType
'businessId': '6a73a' # business uuid
'owner': '38c7f', # user uuid
'createdAt': '2021-01-01',
'updatedAt '2021-09-24',
}

get_app_paths

paths: List[str] = shimoku.app.get_app_paths(app_id)
That returns a dictionary such as:
paths = ['Catalog', 'Catalog map']

get_app_reports

Retrieve all Suites that belong to a business for instance you can do
app_reports: List[Dict] = shimoku.app.get_app_reports(app_id)
That returns a dictionary such as:
# This business contains 2 reports a table and a set of indicators
app_reports = [
'b58c3', # a report UUID --> The set of 4 indicators in the image below
'70d8e', # another report UUID --> The table in the image below
]
Such as in:
Copy link
On this page
get_app
get_app_paths
get_app_reports