Documentation

Dashboard

The dashboard is the page you land on after signing in. It summarises today's activity across your assistants and gives you the shell — sidebar, search, credits, notifications — that every other page in the app shares.

The Hiroi dashboard: a row of KPI cards above a Conversations chart, a Channels card, and a Recent Activity feed

The KPI row

Four cards sit at the top of the page.

Card What it counts
Today Conversations that started today, with the percentage change against yesterday
Messages · all time Every message your assistants have exchanged, since the account was created
Active assistants Assistants that are currently enabled. If some are switched off, the card reads 3 of 5
Credits today Credits spent today on model, text-to-speech, speech-to-text and voice cloning

"Today" is your local calendar day. Your browser sends its time zone with the request, so the figure rolls over at midnight where you are, not at midnight UTC.

The change indicator on Today only appears when today and yesterday differ. If you had no conversations yesterday and some today, it shows +100%.

Large numbers are abbreviated: 1,200 becomes 1.2K, 3,400,000 becomes 3.4M.

Note

Credits today is not shown on self-hosted enterprise deployments, which do not use credits.

Conversations chart

The chart plots conversations started per day. Use the 7d / 30d control in the card header to switch the range; the caption under the title shows the total for the selected range.

If nothing happened in the range, the card shows No conversations in this period instead of an empty chart.

For a breakdown by outcome, channel and cost, open Analytics.

Channels

The Channels card lists lifetime volume for each channel:

  • Chat — widget conversations
  • Voice — phone calls
  • SMS — text messages

Analytics in the card header jumps to the full analytics page. At the bottom of the card, 30-day credits shows what you have spent over the last 30 days and links to Billing and credits.

Recent Activity

The last six things your assistants did, newest first. Each row shows a channel icon, a one-line summary, how long ago it happened, and a badge naming the assistant involved.

Activity Log in the card header opens the full, filterable feed — see Activity log.

First run

If you have not created an assistant yet, a setup card appears above everything else with three steps: name your assistant and describe your business, customise its appearance, and add it to your website.

  • Create your first assistant opens the assistant list, where you can start a new assistant.
  • I'll explore on my own dismisses the card.

Dismissal is stored in the browser you dismissed it in, so the card can reappear on another device or after clearing site data. It disappears permanently once you have at least one assistant.

See Quickstart to walk through those three steps.

The sidebar

The sidebar carries the Hiroi Assistant wordmark, your workspace switcher, and the primary navigation:

Item Goes to
Dashboard This page
Conversations Conversation history
Live Chat The human handoff console — only shown when live chat is enabled for your account
Assistants Your assistants
Outbound Outbound verification, phone numbers and the mailboxes your assistants send from — only shown when those channels are enabled for your account
Analytics Analytics
Activity Log Activity log
Settings Settings
Documentation These docs

Three pages have no sidebar entry but are reachable from search or by URL: Billing, Contacts and Voice Studio.

The double-chevron button below the navigation collapses the sidebar to an icon rail; hover an icon to see its label as a tooltip. Your choice is remembered in the browser. At the bottom sit your name, your avatar and the Logout button. On narrow screens the sidebar becomes a drawer opened from the button at the far left of the top bar.

Switching workspace

The control directly under the wordmark shows your current organization. If you belong to more than one, click it and pick another; personal workspaces are marked with a Personal badge and the active one carries a check. Switching reloads the page so every surface picks up the new workspace. With only one organization the control is a static label.

The top bar

The top bar shows the current page title on the left, then four controls on the right.

Click Search… or press ⌘K (Ctrl K on Windows and Linux) anywhere in the app to open the command palette.

Opening it with an empty box shows suggestions: Quick actions, Recent assistants, Jump to (the main pages), Settings and Documentation.

Type two or more characters and it searches:

Group Matches on
Assistants Assistant name or domain
Conversations Visitor ID or session ID
Contacts Name, phone, email or company
Pages Page names and their keywords
Settings Individual settings tabs
Documentation Doc page titles, sections and slugs

Use ↑ and ↓ to move between results, ↵ to open one and Esc to close the palette. Focus stays in the input the whole time, so you can keep typing to refine.

Credit balance

The chip next to the search box shows your current credit balance. Click it to open Billing and credits, where you can top up. The chip is not shown on self-hosted enterprise deployments.

Theme

The sun/moon button switches between light and dark. The change applies immediately and is saved to your account, so it follows you to other browsers.

Notifications

The bell opens a panel of recent account events. A badge on the bell counts unread items, capped at 9+.

  • Filter with All or Unread.
  • Items are grouped under Today, This week and Earlier.
  • Clicking an item marks it read and, where there is a relevant destination, takes you there — a billing event opens Billing, a security event opens your security settings, and so on.
  • Mark all read clears the unread state for everything.
  • View all activity at the foot of the panel opens the activity log.

Opening the panel does not mark anything read on its own. The list refreshes every 60 seconds while the app is open.