open bouquet readme

Open Bouquet Developer Hub

Welcome to the open bouquet developer hub. You'll find comprehensive guides and documentation to help you start working with open bouquet readme as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Documentation

Getting started with Bouquet

Overview : a complete use case to create a bookmark and publish it in an app.

In this example, we assume you know your database and what it contains.

Download and Install Bouquet

Using Windows
Using Mac OS
Using Linux

Connect to a database

Open the Bouquet app for the first time.

You'll be automatically connected to your own team. The project creation popup should open as bellow.

Fill it with your database parameters. Don't forget to select at least a schema and click check connection
If you need more details see the guide : How to create a project ?

You can at any time use another database by modifying the current project or creating another one

Our zero-commute feature import schemas and directly populate the model. In case relations are already defined in your database, Bouquet can generate relations by itself.

Analyze your data

Open your project, select a table you want to analyze and click the "barchart" action button.

  • Select the information you need to analyze. These will be your pivots
  • Select the metric(s) you need to calculate
  • Select a period and set up filters if needed
  • Run your analysis by clicking the "Refresh" button

Save a bookmark

Now that you are happy with your analysis, you can save it as a bookmark, by hitting "Save as".
The whole analysis configuration is saved now, for later use.


You can select default (Year to Date, Previous Month, ...) & comparison periods before saving the bookmark. Periods are then dynamically computed at query execution when coming from the bookmark. Otherwise, static dates are saved & won't change whenever the execution is.

Use my bookmark into a web app

The first possibility to review your bookmark is to open it from the Bouquets' native web application : the Viewer.
Select your bookmark int the "Bookmarks" section of the left panel and click the "barchart" action button.

It is also possible to embed this analysis directly into your own web application.

First, you have make public your bookmark by using the button "publish API" and click "Publish" in the popup window.

Publishing a Bookmark in Bouquet.

  • Within Bouquet, a Bookmark is by default available to you and authorized members with whom youʼve already Shared this Bookmarkʼs project.
  • Publishing a bookmark allows to access it by other users or applications via an access key.

Once published, you need to retrieve the API endpoint of the bookmark: Hit the "Explore API" button on top of the viewer. You have access now to the API request matching the bookmark definition.

If there is an access token, do not copy it.

This API request can be used into a java script page to show your data as a table

You'll find all the code you need to build your first page here :

In the java script code, copy your bookmark token in the function "update(accessToken)".

See more example of possible code for data visualisation on our demo page :

Getting started with Bouquet

Overview : a complete use case to create a bookmark and publish it in an app.