Skip to content

Quickstart

This walks you from nothing to a live, assistant-built dashboard. Budget ten minutes. If any step doesn’t work as written, that’s a bug: tell us with Feedback at the bottom of the console’s sidebar.

  1. Sign up and create a project.

    Sign in to the console. A fresh account lands on the welcome screen: name your project (one per product or site is typical) and create it. You get a write key (nrw_…) immediately.

    Already skipped the welcome flow? Head to Projects → New project; the key is on the project’s page, next to a pre-filled install snippet.

  2. Install the SDK and send your first events.

    With a coding agent (Claude Code, Cursor, Codex and similar), paste one line:

    Install Narrato analytics in this project: follow https://narrato.app/install. My write key is <your-write-key>.

    Your project’s page in the console shows this prompt with the key filled in. The agent reads the install guide, picks the right place for your framework, adds a few meaningful events and checks that the first one arrives.

    By hand, drop the snippet from your project page into your product. With a bundler:

    import * as narrato from '@narrato-app/sdk-web';
    narrato.init('<your-write-key>', { host: '<your-api-url>' });

    Or with a plain script tag:

    <script src="https://unpkg.com/@narrato-app/sdk-web@0.1.3/dist/index.global.js" integrity="sha384-VfaFigAs9+sz2beCxFuZXSgi6ajbUl6ElD/6kXZhyYTmURyRGY9DTXTGWKWB5/VW" crossorigin="anonymous"></script>
    <script>
    narrato.init('<your-write-key>', { host: '<your-api-url>' });
    </script>

    Page views are tracked automatically from the moment init runs. Add custom events wherever something meaningful happens:

    narrato.track('signup_completed', { plan: 'free' });

    The write key is a public identifier, so it’s fine in page source. It can only write events to your project, never read anything. More in Projects & write keys.

  3. Watch the first event arrive.

    Load a page with the snippet installed, then check the console: the welcome screen polls live and flips to “you’re live” within seconds; the Overview page’s event counters follow. If nothing arrives within a minute:

    • Open your browser’s network tab and look for calls to /api/v1/ingest/batch. A 401 means the write key is wrong or was revoked. Any site can send events; there’s no origin list to get onto.
    • Pass { debug: true } to init to log SDK activity to the browser console.
  4. Ask for your first dashboard.

    Once events are flowing, the console offers a short guided setup: answer a couple of questions about your product and the assistant builds a starter dashboard from your real data. Or just open Chat and ask directly:

    “Build me a dashboard with daily event volume, top events this week, and unique users.”

    The assistant inspects your live schema, verifies every widget query against real data before saving, and links the dashboard when it’s done. Every widget re-queries on view: it’s a live lens, not a snapshot.

  5. Keep going.

    • Teach the assistant your domain language on the Context page (what events mean, which are deprecated). It uses that on every question.
    • Ask for a report when you want a frozen, shareable write-up instead of a live dashboard: Dashboards & reports.
    • Bringing teammates? Create a team from your project.

The SDK is browser-first, but the HTTP API takes events from anywhere. Send POST /api/v1/ingest/event (or /batch, up to 1000 events) with your write key in the X-Narrato-Write-Key header:

Terminal window
curl -X POST '<your-api-url>/api/v1/ingest/event' \
-H 'Content-Type: application/json' \
-H 'X-Narrato-Write-Key: <your-write-key>' \
-d '{"event_name": "invoice_paid", "user_id": "user-42", "platform": "backend", "properties": {"amount_usd": 49}}'