We use this tag to select which content to display, as our database supports multiple languages and geographies. If the format differs, there may be an error. Please let us know if adjusting the lang tag is a problem for you.

💡 Remember to register your locales and your embed locations in the Settings.

How to use the Dashboard

You can find our Dashboard at dashboard.branchly.io.

Setup, Settings, and Design

Login

To log in, you have the option to sign in with email, Google or Microsoft.

• Email: Enter your email address and password you used to create your account.

• Google: Click the Google button to sign in with your Google account. This will authenticate you using your Google email and password.

• Microsoft: Click the Microsoft button to sign in with your Microsoft account. This will authenticate you using your Microsoft email and password.

Manage Content Navigators

To access the Content Navigator dashboard, log in to your branchly account. In the Organisation view, you will see an overview of all your existing Content Navigators as well as options to create new ones.

Home

The home dashboard provides an overview of the status, basic analytics, and important information about your Content Navigator.

• Status: Displays the current status of your Content Navigator, either in development or production mode.

• Locations: An overview of the locations where your Content Navigator is embedded.

• Searches: The total number of searches performed in your Content Navigator within the selected time period (coming soon).

• Navigation: The total number of navigations that occurred within your Content Navigator in the selected time period (coming soon).

Designer

You can style and customize your Content Navigator using the following options:

• Navigator Title - Configure the Title to specify how users will be greeted in their language.

• Font Family - Choose between various font families to style the text in your Content Navigator. Options include sans-serif fonts like Arial or Helvetica, serif fonts like Times New Roman or Georgia, and monospace fonts like Courier New or Menlo.

• Font Color - Select a color to use for the main text section in the Content Navigator including titles.

• Background Color - Choose a background color to use for the entire Content Navigator interface.

• Background Image URL - Add a custom background image to your Content Navigator by entering the URL of an image. The image will be tiled to fill the entire background.💡 You can choose between displaying an image or a background color, not both.Button Color - Choose a color to use for the search button.

• Home Button Color - Select a custom color to use specifically for the home button.Button Font Color - Pick a color to use for the text on the Home Button.

• Next Nodes Color - Choose a color to use for the "next node" buttons that navigate between nodes in your Content Navigator.

• Next Nodes Font Color - Select a color to use for the text on the "next node" buttons.

• Selected Nodes Color - Pick a color to use for the already selected nodes.

• Selected Nodes Font Color - Choose a color to use for the text on the currently selected nodes.

• Maximum Nodes Displayed - Set the maximum number of “next node” buttons to display in your Content Navigator. Additional nodes will be accessible via "plus” button.

• Sticky Searchbar Mobile - Enable a search bar that sticks to the bottom of the screen on mobile devices for easy access.

• Sticky Searchbar Desktop - Enable a search bar that sticks to the bottom of the screen on the desktop for easy access.

• Sticky Searchbar Color - Choose a custom color to use for the sticky search bar.

Settings

This section describes the options for configuring your Content Navigator. The fields include:

• Navigator name: A text field to enter a name for the Content Navigator

• Website Location: Where on your website do you want to embed the navigator? Please enter one or multiple valid URLs here.

• Knowledge Base Language: Set the language (and country) for your Knowledge Base. To create a multi-language Knowledge Base, add multiple language and country combinations. We require a valid two-digit ISO language and country code, e.g. en_US for English/United States. We use this code to show the appropriate content, as our database supports many languages and countries. 

Advanced Settings:

• Status: A drop-down menu to select either 'Development' or 'Production'

• Edge Weighting: We recommend using the default options of weight_manual and weight when getting started. After time, you can switch from using weight as your secondary weight to a dynamic method.

• Search Output Sensitivity: We recommend using the default options when getting started. We do not use fixed weights to determine what to display to users. Instead, we use an algorithm to dynamically determine what to show to the user after a search has been performed, based on the quality of the search results. It considers the scores of the results and the differences between them, and returns different types of search output depending on the results score.

• AI Model (deactivated): We currently provide our own AI model that works for all major languages. It is well-ranked for semantic search tasks. We use ChatGPT (GPT-4) from Azure OpenAI Service for generating responses in the Chat. Let us know if you are interested in using alternative model providers.

Knowledge Base

Nodes

All nodes are displayed in a table with the following attributes:Title: The title of your node. Users will see this title when using the navigation.Label: The label of the node. Possible values are Content, Contact, Entry and Fallback. Entry, Fallback and four different Contact Nodes are created automatically for you to use. Text: The main content text as html.ID: A unique identifier for the node.Timestamps: The date the node was created and last updated.Use the language selector at the top of the table to change the displayed locale. This allows viewing and editing the nodes for different languages/geographies.You can edit an existing node by clicking "edit" next to it. This will open the Node Editor where you can modify the node attributes for each supported language. The node editor allows full management of multilingual content in your knowledge base. You can update the title, text, images, files, etc. for the node in different locales.

Data Sources

Using our Rootseeker, you can integrate your existing content from a variety of data source. At the moment, we offer a website crawler and file upload. We have a couple of additional Data Sources on our Roadmap, but if you need a specific one please let us know.

Website Crawler

The Website Crawler starts with the URLs, finds links to other pages, and recursively crawls those pages, too, as long as their URL is under the start URL. For example, if you enter the start URL https://example.com/blog/, the crawler will crawl pages like https://example.com/blog/article-1 or https://example.com/blog/section/article-2, but will skip pages like https://example.com/docs/something-else. Using the option Split Documents, we can try to identify the semantic structure of the website using its heading and create multiple Nodes for you. The results of this depend on the semantic quality of your website.

File Upload

We currently support reading in PDF files. Using the option Split Documents, we can try to identify the semantic structure of the PDFs and create multiple Nodes for you. As PDFs are inherently unstructured, the results of this depend on your input documents.

Analytics

We provide various analytics and monitoring options to gain insights into how your users interact with the Search Navigator and Chat. We provide Analytics via Tableau. You need to have an active Tableau Viewer license assigned to you. If you see an error message indicating this, please contact your account manager for support.We already provide the following information on request:

Dimensions

• locale : The locale of the navigator.

• navigator_id: The ID of the navigator.

• date : The date in ISO format.

Measures

• total_sessions: This calculation returns the total number of unique session IDs.

• sessions_w_interaction: This calculation returns the number of sessions where there was an interaction with the user (i.e., the selected node label was not 'entry').

• successful_sessions: This calculation returns the number of sessions that were successful, where success is defined as either reaching a 'contact' node or reaching the last node in the knowledge base that contains the final content.

• navigation_sessions: This calculation returns the number of sessions where the entry point was the 'navigation'.

• navigation_sessions_w_interaction: This calculation returns the number of navigation sessions where there was an interaction with the user.

• search_sessions: This calculation returns the number of sessions where the entry point was 'search'.

• total_requests: This calculation returns the total number of requests made across all sessions

Metrics and Ratios

1. Interaction rate: The percentage of sessions where there was an interaction with the user, calculated by dividing the number of sessions with interaction by the total number of sessions.

2. Success rate: The percentage of sessions that were successful, where success is defined as either reaching the 'contact' node or reaching the last node in the knowledge graph, calculated by dividing the number of successful sessions by the number of sessions with interaction.

Support

If you have any questions or issues while using branchly, please reach out to our support team at hello@branchly.de. We are always happy to help!