Guides
On this page
Start with a first query, follow a complete example, or go straight to the task you need to finish.
Run your first query
The quickstart takes you from an empty table to your first event query in the Console. You only need a ready workspace and your browser sign-in.
Writing from an application or terminal? Connect a client to get an API key, configure the address, and check the connection.
Start with your agent
Paste this prompt into an agent with web and terminal access. It installs the ScopeDB skill, connects to your workspace, helps you answer your first question with read-only queries, and turns results into interactive charts you can open offline.
Install the ScopeDB skill from https://github.com/scopedb/scopedb-skills and help me get started.For manual installation, workspace context files, and chart export with ScopeView, see the Agent skill guide. For account setup and supported agents, see the agent setup FAQ.
Follow a complete example
See what you can build before adapting the workflow to your own data. Each tutorial walks through a runnable producer project, streams events into ScopeDB, and runs the queries that turn raw rows into an operational or analytical result.
Investigate application errors keeps a checkout simulator sending logs with the JavaScript SDK. Use Console to locate the release and payment gateway behind a failure spike as requests arrive.
Analyze Bluesky activity keeps a Go SDK producer writing live public activity while a fixed sample helps you check the analysis. Compare new posts, replies, and reactions in Console without double-counting replays.
Analyze Cloudflare Worker traffic deploys a single Tail Worker in your Cloudflare account to stream Worker invocations, logs, and exceptions into ScopeDB. Separate browser document navigations, background prefetches, and AI crawler or Markdown reads, and export interactive charts with ScopeView.
Complete a specific task
Use Work with events when you know what you want to do. Examples run in the Console or through a client.
| Task | Guide |
|---|---|
| Choose stable columns and keep changing payloads | Model event data |
| Load new events and check the result | Ingest events |
| Find failures, inspect payloads, and compare counts | Query events |
| Make recurring filters and searches faster | Add indexes |
| Decide how long to keep a table's data | Set data retention |
| Understand table size and reduce query work | Understand storage |
Build with a client
The SDK overview helps you choose a client and check its published version and runtime requirements. Follow the JavaScript, Go, or Rust guide to query, write events, and manage table definitions from your application.
Use the ScopeDB CLI for interactive queries, shell scripts, and automation. For request and response contracts or a custom HTTP client, use the API reference.
Find your way around
Use the Console for illustrated help with Tables, Explore, and Query.
Manage your workspace covers API keys, members, usage, and workspaces and sessions.
For exact language behavior, look up the ScopeQL reference.