Docs

Getting started

Vertex turns raw product events into funnels, retention curves and alerts. This guide takes you from an empty workspace to your first tracked event in about five minutes.

Create your workspace

Sign up with your work email (or the simulated Google button — this is a demo, no real OAuth happens). Every account gets one workspace on the Starter plan with 10k tracked events per month, which is plenty for wiring things up.

A workspace maps to one product. If you run several products under Lorem Ipsum Co, create a workspace per product so funnels and retention cohorts never mix.

Grab your API key

Open Settings → API keys and copy your live key. Keys are prefixed so you can tell them apart at a glance: vx_live_ keys count against your event quota, vx_test_ keys write to a scratch environment that is wiped nightly.

Keep live keys out of source control — inject them through your environment instead.

bash

# .env — never commit this file
VERTEX_API_KEY="vx_live_lorem1p5um4d1p1sc1ng3l1t"
VERTEX_ENV="production"

Send your first event

The fastest way to confirm the pipeline is a raw HTTP call. Events are accepted at the collect endpoint and show up in the live view within a second or two.

bash

curl -X POST https://api.lorem.example/v1/events \
  -H "Authorization: Bearer $VERTEX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event": "signup", "userId": "user_0001", "properties": {"plan": "starter"}}'

Where to go next

For real products you will want the browser snippet rather than raw HTTP — it batches events, retries on flaky networks and tracks page views automatically. That is the next guide.