Quickstart
Go from zero to your first coverage scan in under 10 minutes. This guide walks you through creating a workspace, defining events, and running the scanner.
Sign up & create a workspace
Sign in with Google at https://app.ordaze.com. After signing in you'll be prompted to create your first workspace. Give it a name that matches your app or product (e.g. MyApp).
Define your first events
Go to Events in the sidebar and click Add Event. Create a few events that your app already tracks.
- Name — the event key used in code (e.g.
purchase_completed) - Description — what triggers this event
- Properties — the payload fields (optional for now)
Publish a version
Go to Versions and click Publish. This creates an immutable snapshot of your event registry. The scanner needs at least one published version to compare against your codebase.
Generate an API token
Go to Developers → Tokens and create a new token. Copy it — you'll need it for the scanner.
Run the scanner
In your workspace's root directory, run:
ORDAZE_TOKEN=YOUR_TOKEN bash <(curl -sL https://app.ordaze.com/api/v1/scanner)The scanner auto-detects your platform (iOS, Android, or backend), scans for event usage, and reports results back to Ordaze. Check the Coverage tab in the dashboard to see your results.