Toucan 3.0
YouPrep documentationHelp centerGet a demo
  • Welcome
    • 👋Welcome to Toucan
    • ⚙️Technical resources
      • ⚙️Toucan stack
      • Setup mode
        • Toucan SaaS mode
      • ⚙️Security
        • Application Security
        • Source Code Quality
        • Global Security Practices
        • Security of Docker Images
  • TUTORIALS
    • 📊Getting Started : Embedded Analytics
    • 🤓Advanced tutorials
      • Embedding a story with user attributes
        • Dynamic filter with user attributes
        • Dynamic Tables
        • Dynamic Database
        • Dynamic Host
      • Using the HTTP API connector in advanced use cases
      • Using advanced syntax for SQL queries
      • Merging filters with our tool
      • Deep customization chart (CSS)
        • Homepage customization
        • Chart customization
        • Dashboard customization
  • Data Management
    • 🧮Overview of Data In Toucan
    • 📡Datasources in Toucan
      • 🔌Managing Connectors
        • 🔌Creating, editing and deleting a connector
        • 🔌Set up OAuth2 credentials for your platform
        • 🔌Setting up a connector
          • 🔌Generic Connectors
            • 🔌Setting up an HTTP API connector
            • 🔌Setting up an ODBC Connector
          • 🔌Database and data warehouse Connectors
            • 🔌Setting up an AWS Redshift Connector
            • 🔌Setting up a Snowflake Connector
            • 🔌Setting up a PostgreSQL Connector
            • 🔌Setting up a Google Big Query Connector
            • 🔌Setting up an AWS Athena connector
            • 🔌Setting up a MySQL connector
            • 🔌Setting up a MongoDB connector
            • 🔌Setting up a Microsoft SQL Server connector
            • 🔌Setting up an Azure SQL connector
            • 🔌Setting a Databricks Connector
            • 🔌Setting up a ElasticSearch Connector
            • 🔌Setting up a Clickhouse Connector
          • 🔌Online services connectors
            • 🔌Setting up a Sharepoint Connector
            • 🔌Setting up a Google Sheets Connector
            • 🔌Setting up a Salesforce Connector
            • 🔌Setting up a Hubspot Connector
          • 🔌Setting up an AWS S3 connector
      • 📁Managing Files
        • 📁Adding, editing and deleting local files
        • 📂Using advanced file settings
        • 📁Adding and combining remote files in Toucan
    • 🔢Datasets in Toucan
      • 🔢Stored and Live Datasets
      • 💿Managing datasets
        • 🔢Creating datasets
        • 🔢Editing, Duplicating and Deleting a dataset
        • 🔢Refreshing and Publishing Datasets
        • 📈Optimize data performance
        • 🗂️Adding indexes to stored datasets
        • 👩‍💻Code mode and single mode
      • 🛑Setting permissions on dataset
      • 🗃️Maintaining Data
        • 🗃️Tagging datasets
        • 🗃️Identifying datasets dependencies
        • 🗃️Set validation rules
    • 🧑‍🍳Preparing data
      • Overview of YouPrep™
        • 🎹Column header
          • Rename column
          • Duplicate column
          • Fill null values
          • Replace values
          • Sort values
          • Convert columns data types
        • Add
          • Add text column
          • Add formula column
          • Add conditional column
        • Filter
          • Delete columns
          • Keep columns
          • Filter rows
          • Top N rows
          • ArgMax
          • ArgMin
        • Aggregate
          • Group by
          • Add total rows
          • Hierarchical rollup
          • Get unique groups/values
        • Compute
          • Compute evolution
          • Cumulated sum
          • Percentage of total
          • Rank
          • Moving average
          • Compute statistics
          • Absolute value
        • Text
          • Concatenate
          • Split column
          • Extract substring
          • To lowercase
          • To uppercase
          • Compare text columns
          • Trim spaces
          • Replace text
        • Date
          • Convert text to date
          • Convert date to text
          • Extract date information
          • Add missing dates
          • Compute duration
        • Reshape
          • Pivot
          • Unpivot
          • Waterfall
        • Combine
          • Append datasets
          • Join datasets
        • Geo
          • Geographic dissolve
          • Geographic hierarchy
          • Geographic simplify
          • Prepare geo data (with basemap)
      • YouPrep™ Native SQL
      • Hybrid pipeline
    • ➿Managing variables in Toucan
      • ➿Variables hub
      • ♈Use variables in YouPrep™
      • ➿Easy reference to variables
    • 🧞Using advanced data concepts
      • 🧞Data personnalisation with user attributes
        • Connector setup with a user attribute
        • Database selection with a user attribute
        • YouPrep data filtering with a user attribute
        • Filter data in SQL with a user attribute
      • 🧞Advanced syntax for variables
      • 🧞Data cache
  • Visualizations and Layouts
    • 📺Apps
      • 📺Managing Apps
        • ➕Creating Apps
        • 📄Duplicating Apps
        • 🖨️Publishing Apps
        • 🚮Deleting Apps
        • ✍️Editing within an App
      • 🖌️Customizing Apps
        • Customizing chart color elements
        • Customizing the app's font
        • Adding Assets
        • Adding Glossary
        • Setting up, Managing and testing custom visibilities
        • Customizing the "no data error" message
        • Creating a dynamic background based on an Filter's column
      • 🏠Home
        • Creating the Home
        • Creating Tiles
          • Tile Dynamic Value
          • Tile Leaderboard
          • Tile Line
          • Tile Scorecard
          • Tile Bullet
          • Tile Heatmap
          • Tile PDF
          • Tile Video
          • Tile Image
          • Tile Text
          • Tile HTML
          • Tile Separator
      • ✨Stories
        • Creating a Story
        • KPIs
        • Narrative
        • Crossfilter
      • 📽️Filters
        • Managing Filters
          • Creating, reusing and editing Filters
          • Applying Filters
          • Unpinning and deleting Filters
        • Type of Filters
          • Dropdown
          • Checkboxes
          • Buttons
          • Date Range
          • Hierarchical
          • Slider
        • Templating from Filters' values
        • Dependant Filters
      • 📈PDF Report
      • 🎡Datawall
      • 🏗️Dashboard Builder
        • Create a Dashboard Builder
        • Embed a Dashboard Builder
        • Dashboard export options
      • 🌟MyFavorites
    • 📊Creating Visualizations
      • 🤩Viz Gallery
        • Barchart
        • Barlinechart
        • Bubblechart
        • Bulletchart
        • Circularchart
        • Funnelchart
        • Gantt chart
        • Heatmap
        • HTML
        • Leaderboard
        • Leaderboard Centered Average
        • Linechart
        • Mapchart
          • Configure a drill
        • Mediachart
        • Radarchart
        • Tablechart
        • Timeline
        • Versuschart
        • Waterfallchart
        • Score Card
        • Stacked Barchart
      • 🧠Common Chart Configuration
      • 💅Customizing chart colors
      • 🧞‍♂️Advanced chart configuration
        • Templating from chart's dataset
        • Add units, precisions and sentiments
        • Adding Tutorials
        • Add sparklines
        • Navigate with stories
        • Group informations in your stories
        • Multiple charts in one story
        • Manage dates
        • Customize tiles' sources
        • Add stars to tiles' title
        • Manage data order in your tiles
        • Navigate with tiles
    • 👩‍💻Embedding
      • 🔐Authentication
      • 🖇️Integration
        • Generate and manage embeds
        • Customize embeds
        • Embedding a Toucan App Using iFrames
        • Passing Extra Variables to Your Toucan Embed
      • ⚙️Embed SDK
        • Embed SDK Authentication
      • ❓FAQ
    • 🙋Self-Service
      • Self-Service Dashboard
      • Self-service PDF Report
  • Collaboration
    • ⏰Creating alerts
    • 📧Managing notifications
    • ➕Enriching a story with descriptions
    • 💌Sharing content
    • 💬Adding comments to stories
  • Administration
    • Page
    • ⚙️Instance Management
      • ⚙️Managing operations in SaaS
      • ⚙️Customizing your instance (whitelabel)
    • 👥Managing Users
      • 👥Users
      • 👥Managing user groups
      • 👥Managing user properties
      • 👥Setting up permissions and visibilities
    • 🌐Managing languages in Toucan (internationalisation)
    • 📈Monitoring Engagement with User Analytics
      • 🎛️How to Filter your User Analytics?
      • 🖥️Understanding your User Analytics Dashboards
  • Additional Ressources
    • 📚External documentation
    • 🚁Support for App-builders
    • 🆕Latest releases
      • 🎁2025 Releases
      • 🎁2024 Releases
      • 🎁2023 Releases
    • 🔧Troubleshooting
      • Troubleshoot:: DataHub
      • Cross-Site Cookies
      • How to :: read the inspector error
      • How to :: troubleshoot the toucan way
Powered by GitBook
On this page
  • 📖 Introduction
  • 📜 Preface
  • 🎯 Objective of this Getting Started
  • 🚂 Steps to follow when deploying embedded analytics
  • 1) Connect to Data 🔗
  • 2) Create Variables (to Personalize the Experience) 🧪
  • 3) Create Customized Datasets 🚀
  • 4) Create charts powered by storytelling 🎨
  • 5) Embed Charts in Your Interface with Secure Authentication 👩🏻‍💻
  • 👩🏼‍🏫 Summary
  • 👋 Outro
  • 📚 Associated Documentation

Was this helpful?

  1. TUTORIALS

Getting Started : Embedded Analytics

Last updated 6 months ago

Was this helpful?

📖 Introduction

Welcome! If you are here, it means you are ready to dive into the world of embedded analytics with . You want to integrate white-labeled analytics into your product to enrich your offering, impress your clients, and accelerate your roadmap. You are in the right place! 🙌

Whether you are a new client ❤️ ready to get started or a prospect ✨ testing the Free Trial, we will explore together how to navigate effectively to achieve your goals.

📜 Preface

Audience

This guide is for product managers, data analysts, and developers integrating embedded analytics into their software with Toucan. It is for those who want to integrate white-labeled analytics efficiently.

Important Note

This guide does not fully cover authentication management and embedding charts into your code, which are explained in the linked documentation. These aspects are crucial, but this guide focuses on the key steps to get started with embedded analytics. For more details, refer to the associated documentation.

🎯 Objective of this Getting Started

The goal of this guide is simple: to support you step by step in getting started with embedded analytics.

Before you begin, it is essential to understand the major steps. This guide will present these key steps so that you can ultimately integrate personalized charts directly into your product or web portal. 📺

This is not a click-by-click tutorial but rather a general guide to help you get oriented, giving you the necessary foundations to explore. You will find the associated documentation throughout and at the end of this guide.

You will be guided to see how to:

  • Connect to data

  • Create variables (to personalize the experience)

  • Create customized datasets

  • Create contextualized charts

  • Embed these charts into your interface while managing secure authentication

Toucan can integrate analytics into your product at different levels of granularity, from simple and tailored widgets to full dashboards, while displaying the right data to the right person.

You can find documentation about our embedded layouts

You just need to iterate gradually to add more analytics after that.

🚂 Steps to follow when deploying embedded analytics

1) Connect to Data 🔗

2) Create Variables (to Personalize the Experience) 🧪

First, go to the administration interface via the App Store to create the user attributes that will be used to personalize the experience (you need Admin rights for this). These attributes can be of different types and named as you wish, for example:

  • Client: To identify data specific to each client.

  • Region: To adapt the content based on location.

  • First Name: To personalize the storytelling with the user's first name.

These variables should, of course, align with your Data Model and will likely correspond to columns.

Next, return to your Toucan App and go to the Variable Management menu (at the top right) of the application itself. Finally, assign default values to these variables to simulate the user experience.

For example:

  • Client: Apple

  • Region: California

  • First Name: Chris

These values will allow you to view the data as if you were a real user carrying these user attribute values, thereby validating the personalization of visualizations in an app-building environment (Toucan studio).

3) Create Customized Datasets 🚀

Data is the foundation of your project. With YouPrep, Toucan's data transformation tool, you can adjust data to meet your business needs: grouping data, creating conditional rules, performing joins, etc.

By default, Toucan will use the value defined in the Variable Management menu.

4) Create charts powered by storytelling 🎨

This allows your end users to filter and explore their data!

Finally, do not hesitate to complete the Narrative above the chart to give it meaning and make its definition self-explanatory. Variables tied to user attributes can even be directly integrated into the narrative to make the experience more engaging, such as including the user's first name in the text.

5) Embed Charts in Your Interface with Secure Authentication 👩🏻‍💻

To finalize, it is time to integrate your work directly into your software. Use a Json Web Token (JWT)-based authentication system to dynamically pass user attributes to Toucan. It is like the JWT is an ID card, and the user attributes are the characteristics of a person on the ID card: a number, height, eye color, etc.

Copy the web component into your frontend, place the token, and everything is ready! Each user will thus experience a personalized experience based on their data. Here the token was prepared for this demo.

👩🏼‍🏫 Summary

We have explored together the steps to get started with embedded analytics using Toucan: connecting to data, creating variables and customized datasets, creating contextualized charts, and finally embedding them in your interface while managing secure authentication.

Once these skills are mastered, the Toucan solution will allow you to add analytics to your product, without any code, in just a few minutes, providing a personalized and engaging experience.

There is much more to discover such as the use of our SDK (lien) to deeply integrate Toucan with your product or whitelabeling to blend Toucan viz within your design.

👋 Outro

The world of analytics is limitless: your clients probably expect standard indicators shared across your product! 👥 You could even address specific personas or offer a paid analytics module as part of your service offering. 💰 Your website could even feature public analytics or a barometer to raise awareness among your audience about certain metrics! 🌎 In short, data is just waiting for you to bring it to life.😊

This Webinar Replay could help to understand the same Embedded Analytics path also 🎁 It's free!

📚 Associated Documentation

To start, create a Toucan App, then to create a connection to a data source, such as PostgreSQL. This step allows you to establish a solid foundation on which you can build your visualizations.

If you prefer, it is also possible to upload a . This first step is crucial as it provides the necessary data for the following steps.

To provide a personalized experience, it is important that will help to adapt the content for each user.

In Toucan, datasets can be saved as Stored (stored in Toucan - ) or Live (leveraging the underlying data source).

In embedded analytics, data is often processed in real time, and data is segregated by a “Client Identifier” (or "Product Identifier"), which would be a column in a “” data model. If the architectural model is different, we can work with you . We will assume this scenario for this getting started.

Did you know? 👀 YouPrep can even for you for certain compatible connectors.

For example, you can apply a on the column that helps identify a client A or client B (e.g., "Client"). This filter ensures that only relevant data for each user is retained. Once the dataset is transformed and saved, it can be reused in your application, providing a personalized foundation for visualizations.

In production, however, Toucan will use the user attribute value carried by the (see step 5).

Now that your data is prepared, it is time to create contextualized charts. , consisting of one or two charts, with contextualization (narrative, tips, glossary), and filters.

To create these elements, you can follow the various documentation pages ! If you want to move quickly, simply create a chart like a bar chart, leaderboard, or line chart. 😊

Toucan can to charts via the filter bar at the top, relying on a column from your dataset or another dataset with a column of the same name.

We call ‘templating’ syntaxes including variables to make you text (or data) dynamic depending on the context of use. You can refer to the for this or the reference to variables.

Don't forget to change your colors and logos in the and .

You will probably need a developer to finalize this step if you are a customer. ()

Be sure to create with the same syntax as defined in the Variable Management section. For instance, if you have a "country" column to filter, it will be easier if your Variable is called "country".

Once the authentication system is in place (), don't forget to publish your work in production (Publish Button), then generate an embed by clicking on the "..." in the interface.

Of course you can dig in the to deep dive in what we can customize.

If you have any doubts or questions after reading this Getting Started guide, feel free ! 💌

📊
Tiles
Stories
Dashboards
Apps
go to the DataHub
flat file
to create variables
see limitations in the documentation
One Big Table
to find the appropriate solution
write the SQL language
Filter Rows step
Json Web Token
Create a story in a Toucan chapter
accompanied by KPIs
to enrich your Data Story
apply filters
Templating documentation
White Label
Customization Menu
cf doc
user tokens that carry user attributes
see the associated documentation
Integration Documentation
Datasources in Toucan
Dataset in Toucan (live and stored)
Transform data with YouPrep
Manage variables
Tutorial on data variabilization
Variability based on your software's architecture
Create a story
Filters
Authentication
Templating
Easy Reference to Variables
to reach out to us
Toucan
Welcome on our Getting Started for Embedded Analytics
Example of Embedded Analytics (3 tiles on the left)
DataHub >> Datasource >> Add a Connector or a File
App Store >> Settings >> Users >> Properties
App >> Settings >> Variable Management
DataHub >> Create a Dataset >> Play with Youprep!
Use a Filter Rows Step >> Filter our column on a Variable (with a default value already defined)
Don't forget to save your dataset (live mode here!)
Chapter >> Create a Story >> Create a chart from your personalized dataset
On the top of your story >> Create a filter >> then apply the filter in the UI or in Youprep
Nice Data Story isn't it?
For instance: Clement is connected on Breezy, so he can see its own figures compared to Charles!
In Production Mode >> Click on the "..." next to a Story >> Embed Story
Tada 🎉 An Awesome Data Story Embedded into your own frontend!