Skip to content

ANALYTICS.md

Latest commit

 

History

History
64 lines (40 loc) · 1.89 KB

ANALYTICS.md

File metadata and controls

64 lines (40 loc) · 1.89 KB

Supabase Analytics (OpenBento)

OpenBento can track:

  • Inbound traffic: page views on the exported bento page
  • Outbound traffic: clicks on blocks (links / social)

This is done via two Supabase Edge Functions:

  • openbento-analytics-track (public write endpoint - handles auth securely server-side)
  • openbento-analytics-admin (admin read endpoint, protected by a token)

🔐 Security

No API keys are exposed in the exported code!

The analytics system uses Supabase Edge Functions which handle authentication server-side with the SERVICE_ROLE_KEY. The client only needs the Supabase project URL - no anonKey is required or exposed.

1) Provision Supabase

  1. Create a Supabase project
  2. Install the Supabase CLI: https://supabase.com/docs/guides/cli
  3. Get:
    • SUPABASE_PROJECT_REF (project ref)
    • SUPABASE_SERVICE_ROLE_KEY (Settings → API → Service role key)
    • Pick an OPENBENTO_ANALYTICS_ADMIN_TOKEN (any strong random string)

2) Create tables + deploy functions

From the repo root:

SUPABASE_PROJECT_REF=xxxx \
SUPABASE_SERVICE_ROLE_KEY=... \
OPENBENTO_ANALYTICS_ADMIN_TOKEN=... \
npm run analytics:supabase:init

This will:

  • Apply the migration in supabase/migrations/
  • Set Edge Function secrets
  • Deploy the Edge Functions

3) Enable analytics in the builder

In the Builder sidebar:

  1. Go to Analytics (Supabase)
  2. Toggle Enable analytics
  3. Paste your Supabase Project URL (example: https://xxxx.supabase.co)

Note: The anonKey field is deprecated and no longer required. Only the project URL is needed.

When you export, the generated page will automatically send page_view and click events via the Edge Function.

4) View analytics (admin)

In the builder, open Analytics and paste your OPENBENTO_ANALYTICS_ADMIN_TOKEN.

The dashboard calls:

{SUPABASE_URL}/functions/v1/openbento-analytics-admin?siteId=...