Getting started
Exploring and using data
Exploring catalogs and datasets
Exploring a catalog of datasets
What's in a dataset
Filtering data within a dataset
An introduction to the Explore API
An introduction to the Automation API
Introduction to the WFS API
Downloading a dataset
Creating maps and charts
Creating advanced charts with the Charts tool
Overview of the Maps interface
Configure your map
Manage your maps
Reorder and group layers in a map
Creating multi-layer maps
Share your map
Navigating maps made with the Maps interface
Rename and save a map
Creating pages with the Code editor
How to limit who can see your visualizations
Archiving a page
Managing a page's security
Creating a page with the Code editor
Content pages: ideas, tips & resources
How to insert internal links on a page or create a table of contents
Sharing and embedding a content page
How to troubleshoot maps that are not loading correctly
Creating content with Studio
Creating content with Studio
Adding a page
Publishing a page
Editing the page layout
Configuring blocks
Previewing a page
Adding text
Adding a chart
Adding an image block to a Studio page
Adding a choropleth map block in Studio
Adding a points of interest map block in Studio
Adding a key performance indicator (KPI)
Configuring page information
Using filters to enhance your pages
Refining data
Managing page access
How to edit the url of a Studio page
Adding a map block in Studio
Visualizations
Managing saved visualizations
Configuring the calendar visualization
The basics of dataset visualizations
Configuring the images visualization
Configuring the custom view
Configuring the table visualization
Configuring the map visualization
Understanding automatic clustering in maps
Configuring the analyze visualization
Publishing data
Publishing datasets
Creating a dataset
Creating a dataset from a local file
Creating a dataset with multiple files
Creating a dataset from a remote source (URL, API, FTP)
Creating a dataset using dedicated connectors
Creating a dataset with media files
Federating an Opendatasoft dataset
Publishing a dataset
Publishing data from a CSV file
Publishing data in JSON format
Supported file formats
Promote mobility data thanks to GTFS and other formats
Configuring datasets
Automated removal of records
Configuring dataset export
Checking dataset history
Configuring the tooltip
Dataset actions and statuses
Dataset limits
Defining a dataset schema
How Opendatasoft manages dates
How and where Opendatasoft handles timezones
How to find your workspace's IP address
Keeping data up to date
Processing data
Translating a dataset
How to configure an HTTP connection to the France Travail API
Deciding what license is best for your dataset
Types of source files
OpenStreetMap files
Shapefiles
JSON files
XML files
Spreadsheet files
RDF files
CSV files
MapInfo files
GeoJSON files
KML/KMZ files
GeoPackage
Connectors
Saving and sharing connections
Airtable connector
Amazon S3 connector
ArcGIS connector
Azure Blob storage connector
Database connector
Dataset of datasets (workspace) connector
Eco Counter connector
Feed connector
Google BigQuery connector
Google Drive connector
How to find the Open Agenda API Key and the Open Agenda URL
JCDecaux connector
Netatmo connector
OpenAgenda connector
Realtime connector
Salesforce connector
SharePoint connector
U.S. Census connector
WFS connector
Databricks connector
Harvesters
Harvesting a catalog
ArcGIS harvester
ArcGIS Hub Portals harvester
CKAN harvester
CSW harvester
FTP with meta CSV harvester
Opendatasoft Federation harvester
Quandl harvester
Socrata harvester
data.gouv.fr harvester
data.json harvester
Processors
What is a processor and how to use one
Add a field processor
Compute geo distance processor
Concatenate text processor
Convert degrees processor
Copy a field processor
Correct geo shape processor
Create geo point processor
Decode HTML entities processor
Decode a Google polyline processor
Deduplicate multivalued fields processor
Delete record processor
Expand JSON array processor
Expand multivalued field processor
Expression processor
Extract HTML processor
Extract URLs processor
Extract bit range processor
Extract from JSON processor
Extract text processor
File processor
GeoHash to GeoJSON processor
GeoJoin processor
Geocode with ArcGIS processor
Geocode with BAN processor (France)
Geocode with PDOK processor
Geocode with the Census Bureau processor (United States)
Geomasking processor
Get coordinates from a three-word address processor
IP address to geo Coordinates processor
JSON array to multivalued processor
Join datasets processor
Meta expression processor
Nominatim geocoder processor
Normalize Projection Reference processor
Normalize URL processor
Normalize Unicode values processor
Normalize date processor
Polygon filtering processor
Replace text processor
Replace via regular expression processor
Retrieve Administrative Divisions processor
Set timezone processor
Simplify Geo Shape processor
Skip records processor
Split text processor
Transform boolean columns to multivalued field processor
Transpose columns to rows processor
WKT and WKB to GeoJson processor
what3words processor
Data Collection Form
About the Data Collection Form feature
Data Collection Forms associated with your Opendatasoft workspace
Create and manage your data collection forms
Sharing and moderating your data collection forms
Dataset metadata
Analyzing how your data is used
Getting involved: Sharing, Reusing and Reacting
Discovering & submitting data reuses
Sharing through social networks
Commenting via Disqus
Submitting feedback
Following dataset updates
Sharing and embedding data visualizations
Monitoring usage
An overview of monitoring your workspaces
Analyzing user activity
Analyzing actions
Detail about specific fields in the ods-api-monitoring dataset
How to count a dataset's downloads over a specific period
Analyzing data usage
Analyzing a single dataset with its monitoring dashboard
Analyzing back office activity
Using the data lineage feature
Managing your users
Managing limits
Managing users
Managing users
Setting quotas for individual users
Managing access requests
Inviting users to the portal
Managing workspaces
Managing your portal
Configuring your portal
Configure catalog and dataset pages
Configuring a shared catalog
Sharing, reusing, communicating
Customizing your workspace's URL
Managing legal information
Connect Google Analytics (GA4)
Regional settings
Pictograms reference
Managing tracking
Look & Feel
Branding your portal
Customizing portal themes
How to customize my portal according to the current language
Managing the dataset themes
Configuring data visualizations
Configuring the navigation
Adding IGN basemaps
Adding assets
Plans and quotas
Managing security
Configuring your portal's overall security policies
A dataset's Security tab
Mapping your directory to groups in Opendatasoft (with SSO)
Single sign-on with OpenID Connect
Single sign-on with SAML
Parameters
- Home
- Exploring and using data
- Creating content with Studio
- Adding a key performance indicator (KPI)
Adding a key performance indicator (KPI)
Updated by Patrick Smith
In Studio, you can use a key performance indicator (KPI) to translate one phenomenon that lies within data into a simple message. There are three types of KPIs available in Studio:
- Simple KPIs highlight a piece of information. For example, you can create a simple KPI to show the sum of inhabitants in the city in 2021.
- Comparison KPIs compare two subsets of data or two populations. For example, you create a comparison KPI to show the evolution of bike users over time by comparing the number of bike users between 2020 and 2021.
- Ratio KPIs gives the proportion of a population within a larger one. For example, you can create a ratio KPI to know the percentage of women in the total population of your country.
We recommend that you follow some key principles to build clear KPIs:
- A KPI must convey a single message so that a single indicator is emphasized.
- A KPI needs some context so that anyone browsing the page can understand what the KPI is related to.
- A KPI must be meaningful. If you add a picture, a pictogram, or colors, it must serve the message you want to convey.
Step 1: Select the block type
You need to define the block type before you can configure the content you want to add.
- From the preview pane, click the block you want to edit.
- From the left side pane, select KPI as the block type.
- Click Next.
If you change your mind, you can change the block type afterward. The block configuration will be reset after you change the block type.
Step 2: Select the dataset
Select the source dataset to create a graphic representation of the data.
- From the left side pane, select the desired dataset from the list.
A preview of the first 20 records opens in the preview pane.
- Click Next to continue with the configuration.
Step 3: Select the KPI type
After selecting a block type and the input dataset, you can now select the type of KPI to be inserted into the block.
- From the left side pane, select Simple KPI, Comparison KPI or Ratio KPI.
Step 4: Configure the visualization parameters
Configure the visualization parameters for a simple KPI
- From the left side pane, select the function to apply and the field to be used for value computation. When using a date field, select the time scale to be used.
- You can also refine the data shown on the KPI:
- Click Add a condition.
- Select the field from the input dataset.
- Select an operator. Depending on the field type, the available operators may vary.
- Click Confirm.
- (optional) In the Unit field, you can enter the unit associated to the indicator. By default, this unit is placed on the right side of the indicator. You can place it on the left by using the swap toggle.
- Click Next to continue with the configuration.
Configure the visualization parameters for a comparison KPI
When creating a comparison KPI, you create two sets of data so that you can compare them between each other and identify differences.
- From the left side pane, select the function to apply and the field to be used in the first set of data.
- You can also filter or refine the data shown on the KPI:
- Under the desired set, click Add a condition.
- Select the field from the input dataset.
- Select an operator. Depending on the field type, the available operators may vary.
- Click Confirm.
- Repeat the previous instructions to configure the second set of data.
- Configure how to display the comparison between the two sets of data using the parameters from the KPI content section:
- From the Comparison direction drop-down list, select either Set 1 compared to Set 2 or Set 2 compared to Set 1.
- From the Comparison format drop-down list, select either Difference or Ratio percentage.
- (optional) In the Unit field, you can enter the unit associated to the indicator. By default, this unit is placed on the right side of the indicator. You can place it on the left by using the swap toggle.
- Click Next to continue with the configuration.
Configure the visualization parameters for a ratio KPI
When creating a ratio KPI, you create two sets of data so that you measure the proportion of one within the other.
- From the left side pane, select the function to apply and the field to be used in the first set of data.
- You can also filter or refine the data :
- Under the desired set, click Add a condition.
- Select the field from the input dataset.
- Select an operator. Depending on the field type, the available operators may vary.
- Click Confirm.
- Repeat the previous instructions to configure the second set of data.
- Choose how to compute the ratio using the parameters from the KPI content section:
- From the Ratio direction drop-down list, select either Set 1 on Set 2 or Set 2 on Set 1.
- (optional) In the Unit field, you can enter the unit associated to the indicator. By default, this unit is placed on the right side of the indicator. You can place it on the left by using the swap toggle.
- Click Next to continue with the configuration.
Step 5: Configure the visualization styles
Studio includes several predefined layouts for KPIs to display the appropriate data. These layouts help you control how the KPI appears on the page to make it easier to understand.
Some KPI colors are inherited from portal theme colors configured in the back office:
KPI element | Portal theme element |
KPI title | Titles |
KPI context | Text |
Block borders | Boxes border |
For more information about configuring portal theme colors, see Colors.
The block background is white and cannot be configured.
To configure the visualization styles:
- Select a layout.
- Depending on the selected layout, you can add elements to your KPI: a context, a title, or an image. You can either add an image previously uploaded into the plaform, or a public image from the Internet. a. To use an image from your domain, copy its URL from the back office Assets page to the Image asset URL field. b. To use an image that is not on your domain, paste its URL to the Image asset URL field.
- Click Finish.
You can see a summary of the block configuration parameters in the side pane.
- Check the block configuration and click Save.
Your KPI appears in the preview pane.
Once you completed the block configuration, you can click the block again in the preview pane to check and edit the KPI parameters in the side pane.