Skip to content
Help Center Guide · Dashboard OverviewOnboarding Phase 1
3 min readVerified 2026-11-16

Navigate the Dashboard

Learn where Templates, Passes, Wallet Experiences, Delivery Center, Scanner, Batch Operations, and Settings live in the sidebar.

In This Guide

Interactive UI Walkthroughs

Open in 6-Phase Onboarding Guide

Inspect exact dashboard panels, controls, and zoomed callouts related to this guide.

Zoomed UI focus
Key UI elements

Workspace Dashboard — Live KPIs & Registration Trends (Zoomed)

Once your workflow is live, monitor Active in Wallets, Removed from Wallets, Not Installed, Pass Creation Trend, and Wallet Registration Trend from the main Dashboard.

Primary Workspace Navigation

The Passinstance administrative dashboard provides a unified interface for operational monitoring, card design studio, bulk batch processing, and developer configuration. The left-hand navigation sidebar organizes daily workflows into specialized functional hubs:

Workspace sidebar navigation
Workspace sidebar navigation
Navigation Hub & RoutePrimary ResponsibilitiesBacking Backend Capabilities & Entities
Dashboard (/dashboard)Live workspace KPIs, real-time event telemetry, and pass health metricsBacked by Dashboard Analytics API (/api/v1/dashboards/analytics), multi-widget rows, and real-time event streams.
Templates (/templates)Visual pass studio with 7 detail tabs (Overview, Passes, Distribution, Scanner, Analytics, Activity log, Settings)Implements single-table versioning (Template), pre-publish risk checks, custom identifier regex rules, and bundler settings.
Passes (/passes)Directory of all issued passes, externalId lookup, bundleId grouping, history timelines, and drawer editsHigh-concurrency directory backed by structured JSON attributes, lifecycle transitions (PassLifecycleStatus), and instant deactivation/voiding.
Distribution (/templates/download-pages, /delivery-center, /pass-flows)Groups Download Pages (DownloadPage), Delivery Center (EmailSendCampaign), and Pass Flows (PassFlow)Manages public claim pages (/d/:slug), Email/SMS delivery campaigns, and multi-step registration/payment intake (/f/:url).
Automations (/automations, /workflows)Event-driven and e-commerce automation rulesEvaluates UniversalAutomation rules and Workflow triggers (workflow trigger type, workflow action type).
Scanner (/scanner/configs)Counter validation, gate check-in, validation places, and hardware reader setupManages ValidationPlace, ScannerConfiguration, mobile scanner pairings (ScannerKey), and NFC/POS adapters.
Batch (/batch-processing, /batch-notifications)Asynchronous high-volume CSV issuance wizard and scheduled wallet notificationsDrives Batch Jobs API (/api/v1/batch-processing) and Batch Notifications API (/api/v1/batch-notifications).
Wallet Experiences (/wallet-experiences / /pass-projects)Multi-card project hub (Overview, Cards, Audience, Automations, Distribution, Analytics, Settings)Manages PassProject, PassProjectTemplateRole, .pkpasses bundles, and cross-pass automations.
Integrations & Analytics (/settings/workspace/integrations, /analytics)Connected CRM/POS connectors, webhooks, API keys, and reporting suitesManages webhooks (/api/v1/webhooks/*), scoped API keys, and /api/v1/analytics/* reports.

Dashboard Architecture & Telemetry Endpoints

The dashboard metrics engine is powered by a modular widget and caching architecture (Dashboard, Row, Widget, and SharedDashboard entities in Passinstance database). The backend coordinates with Cache Manager to deliver responsive analytics without imposing query load on transactional pass tables:

SYSTEM ARCHITECTURE FLOW
INTERACTIVE ARCHITECTURE
DASHBOARD TELEMETRY PIPELINE
STAGE 01 Client Dashboard
(React / Vite)
STAGE 02 Dashboard Analytics API
(/api/v1/dashboards/analytics
/metrics/realtime)
STAGE 03 Cache Manager
(RBAC-scoped cache with Event Invalidation
STAGE 02 database Aggregates
Pass & Device Counts

Key Telemetry Endpoints

Developers and data platforms can query these analytics endpoints using standard Bearer or session cookie authentication:

  • GET /api/v1/dashboards/analytics: Returns aggregated workspace metrics backed by Dashboard Analytics Engine.getDashboardAnalytics and Cache Manager.
  • GET /api/v1/dashboards/metrics/realtime: Provides high-frequency workspace activity counts and recent installation/scan telemetry.
  • GET /api/v1/dashboards/analytics/range?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD: Returns time-series cohorts over a custom period.
  • GET /api/v1/dashboards/performance: Monitors operational scan and pass delivery performance metrics.
  • GET /api/v1/dashboards/insights: Surfaces automated operational recommendations across your workspace.
  • GET /api/v1/dashboards/export?format=csv|json|pdf: Exports raw dashboard metric tables for BI and reconciliation.

Functional Hubs & Workspace Views

1. Templates Studio (/templates/:id/*)

Create and edit visual templates across 7 tabs (Overview, Passes, Distribution, Scanner, Analytics, Activity log, Settings). Configure image asset slot slots, check WCAG color contrast, manage custom identifier rules, and iterate in an isolated DRAFT state before publishing.

2. Pass Directory & Timeline (/passes)

Search across issued passes using full-text search and filters (status, templateId, externalId, bundleId). Open any pass row in Pass Details panel to inspect its chronological timeline (GET /api/v1/passes/:id/history and /timeline), view paired devices, or trigger push updates.

3. Batch Operations Center (/batch-processing)

Follow the wizard steps (Template -> Upload CSV -> Map Fields -> Sendout options -> Process) to bulk-issue or update passes from CSV files. Download sample schemas (GET /api/v1/batch-processing/templates/:templateId/sample-csv), review field-mapping recommendations (POST /api/v1/batch-processing/templates/:templateId/field-mapping-recommendations), and download /result.csv containing every generated pass URL and externalId.

Important: All dashboard telemetry and search queries are strictly scoped to your active workspace tenant (customerId). Sibling workspaces within the same organization remain completely isolated.

Explore every view interactively in our Interactive Workspace Tour.

Related Product & Developer Documentation

Ready to launch your first pass program?

Create your workspace, configure your pass template, and test a real pass in Apple Wallet and Google Wallet before you scale.