Docs/Admin/Dashboard

Dashboard

The workspace overview page — your command center for day-to-day operations.


Overview

The dashboard provides a real-time snapshot of your entire Hygate workspace. It's designed to surface the information you need most: active sessions, recent activity, system health, and revenue at a glance.


What You'll See

Active Sessions

A live list of all currently running device sessions. Each session displays:

  • Device name — Which device is in use
  • Location — Where the device is located
  • Countdown timer — Time remaining in the session (live updating)
  • Usage plan — Which plan the guest selected

Active sessions are color-coded:

  • Green — Running normally
  • Amber — Nearing completion (under 1 minute remaining)
  • Red — Session interrupted or device unavailable

Module Health Indicators

A set of status badges showing the health of each integration:

ModuleGreenRed
TTLockConnected and respondingCredentials invalid or service down
ShellyConnected and respondingAuth key invalid or service down
StripeConnected and respondingAPI keys invalid or webhook misconfigured

If a module shows red, check:

  1. The integration credentials in Settings
  2. The external service status (Stripe Status, TTLock API, Shelly Cloud)
  3. Network connectivity between Hygate and the service

Revenue Overview

A summary of your revenue for the current period:

  • Total revenue — Sum of all successful payments
  • Payment count — Number of successful transactions
  • Average transaction — Total revenue divided by payment count

The date range for this summary is configurable (Today, This Week, This Month, Custom).

Recent Payments

The five most recent payment transactions. Each shows:

  • Amount — Payment total
  • Status — PENDING, SUCCEEDED, FAILED, or REFUNDED
  • Module — Door access or Device usage
  • Timestamp — When the payment was processed

Click View All Payments to go to the full Payments module.

System Overview

Quick counts of your configured resources:

MetricDescription
LocationsPhysical spaces you've configured
DoorsTTLock smart locks added to Hygate
DevicesShelly IoT devices added to Hygate

How to Use the Dashboard

Morning Check-In

Each morning, review the dashboard to:

  1. Check module health — Are all integrations connected?
  2. Review recent payments — Any failed transactions to investigate?
  3. Note active sessions — Any unusually long sessions?

Monitoring Active Sessions

The active sessions list refreshes automatically. You can:

  • Monitor usage — See which devices are most popular right now
  • Spot issues — A session showing red may indicate a relay problem
  • Recover sessions — Force-end stuck sessions from here

Spotting Issues Early

Watch for these patterns:

PatternWhat It May Indicate
Multiple FAILED payments in quick successionStripe webhook not configured, API key issue
Session stuck on "Finishing..." for >5 minutesRelay failed to turn off, network issue
TTLock showing redTTLock API outage, expired credentials
Session marked CANCELLED frequentlyRelay communication issues with Shelly
Revenue dropped suddenlyPayment page issue, QR code misconfigured

Dashboard vs. Reports

The dashboard shows right now. Reports show history.

  • Dashboard — Real-time data, current active sessions, recent transactions
  • Reports — Historical trends, revenue analytics, usage patterns

Use the dashboard for operational decisions. Use Reports for strategic planning.


Tips

  • Bookmark the dashboard — It's the fastest way to check system health
  • Pin the tab — Keep it open in a browser tab for continuous monitoring
  • Check health indicators daily — Catching a red module early prevents bigger issues
  • Review failed payments weekly — Patterns in failures reveal configuration problems