Skip to content

Latest commit

 

History

History
63 lines (49 loc) · 3.49 KB

File metadata and controls

63 lines (49 loc) · 3.49 KB
title Dashboard overview
description What's where in the Tumban dashboard — sidebar, organization switcher, and which pages back which API endpoints.
icon table-columns

{/* sources: frontend/user/src/App.tsx, frontend/user/src/pages/* */}

The Tumban dashboard at platform.tumban.com exposes the same operations as the API. Every API page in this reference has a Using the dashboard section pointing back to the corresponding UI flow; this page is the map.

Layout

The dashboard has three primary regions:

  • Left sidebar — top-level navigation. Some items are admin-only.
  • Main area — the active page.
  • Sidebar footer — organization switcher, signed-in user info, sign-out button.

Sidebar items

Item What it covers API pages
Home Overview dashboard: stat tiles (including an Action Items tile), a Scan volume — last 30 days chart, and a Recent scans section. List org scans
Scan Submit a single profile URL (deep or quick) and watch it process. Past scans live on the History page. Create scan, Get scan
History Org-wide scan search and filtering — by recommendation, scan mode, date range, and URL/username. List org scans
Usage Bar chart and donut chart for scan throughput and recommendation distribution. Visible to all members. Usage data is dashboard-only — there is no public API to read it. (Dashboard-only.)
API Keys Create, list, and revoke API keys. Create API key, List API keys, Revoke API key
Webhooks Set the default callback URL and rotate the webhook secret. Update org settings, Rotate webhook secret
Organisation Manage members and organization profile. Admin-only — hidden for members. (Not exposed on the API.)

Organization switcher

If your account belongs to multiple organizations, the switcher in the bottom-left of the sidebar shows the active organization and lets you change it. All API requests and dashboard data are scoped to whichever organization is active.

Role-gated UI

Some controls are hidden or display an admin-only notice in the dashboard. The role enforcement on the underlying API endpoints is documented on each endpoint page.

Action Dashboard API
Create / list API keys Members and admins Members and admins
Revoke API key Trash icon visible to all members; the API rejects revocations a member is not authorized for Members revoke their own keys; admins revoke any
Set default callback URL Controls visible to all members; the API rejects a non-admin's save Admin-only — non-admins get 403
Rotate webhook secret Controls visible to all members; the API rejects a non-admin's rotation Admin-only — non-admins get 403
View Usage page Visible to all members, with real usage data (Dashboard-only; not on the public API.)
View Organisation page Hidden for non-admins (Not on the API.)

Sign-in

Sign in at platform.tumban.com with the credentials provided when your organization was onboarded. After signing in for the first time, your organization is provisioned automatically — the API endpoints become reachable as soon as the dashboard loads.