Technical¶

The `lime-bi` cli¶

This addon has a command line interface that can be used from a command prompt to install Lime BI as a Windows service. See Installation for details. For other administrative tasks such as initialization and syncing, use Lime Admin.

lime-bi --help

Setup Embeddings¶

To enable embedding of Lime BI diagrams in clients, you need to configure an embedding secret key:

Login to the Lime BI admin panel.
Go to Admin Settings > Embedding and click "Manage" in the Static embedding section.
Generate an Embedding Secret Key.
Copy the key into your webserver config file (see Embedding Secret Key below).

Endpoints¶

Get embedding URL¶

Any Lime BI diagram is embedded with an URL that includes a signed token (more background info here). The addon provides this URL via a custom endpoint.

GET: /lime-bi/url/?id=<LIME-BI-ID>&type=<question or dashboard>&params={<PARAMETER-NAME>: <LIMEOBJECT-ID>}

The id and type arguments are mandatory, while params is optional.

Syncing the Data Model¶

You can trigger a data model sync via an endpoint:

POST: /lime-bi/task/sync/

This will start an async task and return an object with a task id. With that id you can pull the current status from the core-api: /api/v1/task/?id=<ID>

The endpoint expects the following information in the body of the request:

{
    "database_name": "<LIME-BI-DATABASE-NAME>",
    "username": "<LIME-BI-USERNAME>",
    "password": "<LIME-BI-PASSWORD>"
}

Environment Config¶

The following keys can be overwritten via your webserver config file:

plugins:
  lime_bi:
    embedding-secret-key: <YOUR EMBEDDING SECRET KEY>
    site-url: http://localhost:3000

Embedding Secret Key¶

You need to provide the embedding-secret-key in order to embed Lime BI diagrams in the clients. You can get the key from the Metabase Admin UI, see the section above on Setup Embeddings for more information.

Site URL¶

This has to be the external URL under which Lime BI is available.