Getting Started

Recipes are data models and dashboards for different database schemas. If you're using any solution that we support to collect data into your database, you can install the recipe and use the dashboards & data models in order to analyze the data. You can install the recipes inside the Develop page as follows:

Develop Page

When you click the install button, the recipe may need you to enter the variables that are being used to build the models. When you enter the variables, they're passed as an argument to recipes so that they can dynamically build up the models.

Once you install a recipe, you can click Analyze in order to analyze the models interactive or click Browse in order to see the data and create reports & dashboards.

Upgrading Recipes

If there is a new version of the recipe available in the marketplace, you will see an Upgrade button, you can click it and upgrade the recipe to the new version. Please note that the dashboards and reports created in the UI will automatically be referencing to the models created by the new version of the recipe. Recipes are backward-compatible unless they explicitly indicate otherwise.

How it works

Recipes are backed by GIT and they consist of Jsonnet files representing the dashboards and models. We compile them using the variables provided in the UI and install it to your project. All the public recipes are stored on Github, you can send pull requests or publish your recipe here so that other people can use it on their own projects. Once the PR is merged, your recipe will be automatically visible to all users of Rakam.

While we provide a set of recipes for common use-cases and solutions, you can model your data by creating a recipe in the app. We simplify the process of creating the recipes in the app, you can click the Create recipe from scratch button in the Develop page, give it a unique name and we will open up our IDE automatically. You can learn how to create recipes using our IDE in Compose ] page. To give you the sense of how that works, here is how it looks like:

Updated 11 months ago

Getting Started

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.