Overview
The Analytics Dashboard (/analytics, /analytics/passes, /analytics/downloads, template-level /templates/:id/analytics, and custom views under /dashboards) provides real-time operational telemetry and historical time-series aggregation across your entire workspace without requiring external business intelligence pipelines. Powered by Dashboard Analytics API (/api/v1/dashboards/*) and Analytics API (/api/v1/analytics/*), the console surfaces multi-dimensional metrics spanning pass issuance, active device registrations, platform installation splits, and proactive Pass Health diagnostics.
Operators can toggle between the high-level Overview mode—optimized for executive KPIs, health alerts, and immediate operational status—and the deep Analytics mode for cohort drill-downs across specific templates, distribution channels, and time buckets.
Telemetry Aggregation Architecture
Passinstance separates live operational counters from historical time-series rollups to ensure sub-second dashboard rendering even on workspaces with hundreds of thousands of active passes:
Important: All time-series buckets (
day,week,month) are aligned and evaluated against your workspace's configured regional timezone (GET /api/v1/customer/:customerId/regional-settings), ensuring daily boundaries match your local store operating hours.
Workspace Overview vs. Deep Analytics Modes
| Dashboard View | Backing API Endpoints | Primary Telemetry & Capabilities |
|---|---|---|
Workspace Overview (/analytics) | GET /api/v1/dashboards/analyticsGET /api/v1/dashboards/metrics/realtimeGET /api/v1/dashboards/insights | Real-time active pass counter, 30-day growth deltas, live scan velocity, certificate expiration warnings, and actionable Pass Health recommendations. |
Deep Analytics (/analytics/passes & /analytics/downloads) | GET /api/v1/analyticsGET /api/v1/analytics/overviewGET /api/v1/dashboards/analytics/range | Multi-series charts for pass creation vs. wallet installation, net platform changes (walletAppsChanges), custom date range comparisons, and scoped entity filtering. |
| System Performance | GET /api/v1/dashboards/performance | Push notification dispatch latency, APNs/Google Wallet sync success ratios, and scanner verification response times. |
Filtering Enums: AnalyticsScope, AnalyticsRange, and AnalyticsBucket
When querying GET /api/v1/analytics or GET /api/v1/analytics/overview (request payload), you can slice workspace telemetry across three orthogonal enumerations:
-
1
AnalyticsScope(scope):
- customer: Aggregates all templates, pass flows, and scanner configurations within the authenticated workspace (derived automatically from your session/API key). - owner: Aggregates cross-workspace metrics for organization owners managing multiple sibling environments. - template: Isolates issuance, registration, and removal metrics to a single UUID templateId. - passFlow: Isolates public intake visits, form submissions, and conversion rates to a specific UUID passFlowId.
-
2
AnalyticsRange(range):
- Preset windows: last_7days, last_30days, last_12_months. - Custom intervals: custom paired with ISO YYYY-MM-DD from and to query parameters (from=2026-10-15&to=2026-11-16).
-
3
AnalyticsBucket(bucket):
- day: Daily data points (default for 7-day and 30-day windows). - week: ISO week rollups for multi-month trend analysis. - month: Calendar month rollups (default for last_12_months).
Programmatic Telemetry API Reference
Retrieve Multi-Series Workspace Analytics
Fetch time-series curves for pass lifecycle events, device registrations, and wallet ecosystem distribution:
GET /api/v1/analytics?range=last_30days&bucket=day&scope=template&templateId=b4f29c10-83e1-4a7b-9d12-56e8012a9c04 HTTP/1.1
Host: api.passinstance.com
Authorization: Bearer <access_token>
Response Payload (200 OK)
{
"range": {
"preset": "last_30days",
"startDate": "2026-10-17T00:00:00.000Z",
"endDate": "2026-11-15T23:59:59.999Z",
"bucket": "day",
"timezone": "Europe/Berlin"
},
"scope": {
"type": "template",
"targetId": "b4f29c10-83e1-4a7b-9d12-56e8012a9c04"
},
"summary": {
"totalPasses": 4820,
"activePasses": 3915,
"inactivePasses": 245,
"unclaimedPasses": 660,
"installedDevices": 4380
},
"series": {
"passes": [
{ "bucketStart": "2026-11-14", "created": 145, "active": 3810, "deactivated": 8 },
{ "bucketStart": "2026-11-15", "created": 162, "active": 3915, "deactivated": 5 }
],
"registrations": [
{ "bucketStart": "2026-11-14", "active": 4260, "deactivated": 11 },
{ "bucketStart": "2026-11-15", "active": 4380, "deactivated": 6 }
],
"walletAppsChanges": [
{ "bucketStart": "2026-11-14", "appleNetChange": 84, "googleNetChange": 32 },
{ "bucketStart": "2026-11-15", "appleNetChange": 91, "googleNetChange": 29 }
]
},
"walletAppsShare": {
"apple": 2980,
"google": 1400,
"total": 4380,
"applePercentage": 68.04,
"googlePercentage": 31.96
}
}
Query Real-Time Metrics & Pass Health Insights
To poll live counter states and diagnostic recommendations via Dashboard Analytics API:
GET /api/v1/dashboards/insights HTTP/1.1
Host: api.passinstance.com
Authorization: Bearer <access_token>
{
"generatedAt": "2026-11-15T23:30:00.000Z",
"healthScore": 94,
"insights": [
{
"code": "HIGH_UNCLAIMED_RATIO",
"severity": "warning",
"templateId": "b4f29c10-83e1-4a7b-9d12-56e8012a9c04",
"message": "13.7% of issued passes remain unclaimed after 72 hours.",
"recommendedAction": "Enable automated 48-hour reminder sendouts in Delivery Center."
}
]
}
Related Documentation
-
Review exact KPI formulas in Pass Issuance & Usage Metrics.
-
Analyze channel conversion rates in Distribution & Engagement Analytics.
-
Export underlying raw datasets via Data Exports & Reporting.
