# Orwel

- [Introduction](https://www.orwel.io/docs/introduction.md): Orwel documentation: the SDK, Dev mode, integrations, the REST API and the MCP server.
- [Quickstart](https://www.orwel.io/docs/quickstart.md): Start using Orwel in about 2 minutes: set it up with AI, or call the API directly.
- [API keys and authentication](https://www.orwel.io/docs/authentication.md): Which key sends data, which key reads it, and how to call the API safely.
- [Install Orwel in Next.js, SvelteKit, Astro, Nuxt, Vite and more](https://www.orwel.io/docs/guides/frameworks.md): Where orwel.init() goes in each framework, which environment variable name it reads, how to keep it from running twice, and how to check the install in under a minute.
- [Support](https://www.orwel.io/docs/support.md): Reach the Orwel team by email or book a support session.
- [Orwel SDK](https://www.orwel.io/docs/sdk/introduction.md): Install the Orwel JavaScript SDK and start tracking behavior, features, and conversions.
- [Event Tracking](https://www.orwel.io/docs/sdk/event-tracking.md): Capture user behavior automatically or with a single call, and the semantic catalog behind it.
- [Feature Tracking](https://www.orwel.io/docs/sdk/feature-tracking.md): Map events to product features and measure adoption among your active users.
- [Track conversions and turn them into leads](https://www.orwel.io/docs/sdk/conversions.md): Use orwel.conversion() for signups, demo requests and purchases: examples per form type, the delivery result, deduplication, attribution and the mistakes that lose leads.
- [Attribution](https://www.orwel.io/docs/sdk/attribution.md): First and last touch UTMs and ad click ids, captured by the SDK and joined with your ad spend.
- [CDN & Infrastructure](https://www.orwel.io/docs/sdk/infrastructure.md): How the SDK is distributed and how events reach the server: batched, unload safe and idempotent.
- [AI Skill](https://www.orwel.io/docs/sdk/ai-skill.md): An agent skill that installs and wires the Orwel SDK into any project, correctly, the first time.
- [SDK Reference](https://www.orwel.io/docs/sdk/reference.md): Every method and init option of the Orwel JavaScript SDK (1.7.1).
- [Test your Orwel install with Dev mode and the development key](https://www.orwel.io/docs/guides/dev-mode.md): Send test traffic that never emails anyone, watch every request arrive live, and fix each warning the ingest debugger shows before you switch to the production key.
- [Journeys and features setup](https://www.orwel.io/docs/guides/journeys-and-features.md): Design what to measure in the dashboard, then hand your developer or coding agent the exact code to send.
- [Troubleshooting](https://www.orwel.io/docs/guides/troubleshooting.md): Partial batches (HTTP 207), rejected or unknown event codes, and conversions that fail.
- [Google Ads](https://www.orwel.io/docs/integrations/google-ads.md): Connect Google Ads to see real cost per lead and cost per qualified lead for every campaign.
- [Meta Ads](https://www.orwel.io/docs/integrations/meta-ads.md): Connect Facebook and Instagram ads to see spend and cost per qualified lead next to Google.
- [HubSpot](https://www.orwel.io/docs/integrations/hubspot.md): Send every converted lead to HubSpot as a contact.
- [Connect Claude, Cursor and other agents with MCP](https://www.orwel.io/docs/agents/mcp.md): Give Claude Code, Claude Desktop, Cursor, Windsurf or VS Code access to your Orwel leads, visitors and campaigns through the Orwel MCP server, with copy and paste configs and example questions.
- [Workspaces](https://www.orwel.io/docs/concepts/workspaces.md): Understanding workspace isolation and data scoping
- [Intent signals](https://www.orwel.io/docs/concepts/personalities.md): Behavior patterns Orwel reads from each session and the action each one suggests.
- [Decisive](https://www.orwel.io/docs/concepts/personalities/decisive.md): Quick to act, focused on results.
- [Impulsive](https://www.orwel.io/docs/concepts/personalities/impulsive.md): Acts on immediate urges, high energy.
- [Methodical](https://www.orwel.io/docs/concepts/personalities/methodical.md): Systematic, detail-oriented.
- [Focused](https://www.orwel.io/docs/concepts/personalities/focused.md): Highly attentive to specific tasks.
- [Curious](https://www.orwel.io/docs/concepts/personalities/curious.md): Seeks new information, explores widely.
- [Skeptical](https://www.orwel.io/docs/concepts/personalities/skeptical.md): Cautious, verifies claims.
- [Lost](https://www.orwel.io/docs/concepts/personalities/lost.md): Disoriented or unsure.
- [Social](https://www.orwel.io/docs/concepts/personalities/social.md): Seeks connection with others.
- [Reactive](https://www.orwel.io/docs/concepts/personalities/reactive.md): Responds to external stimuli.
- [Anxious](https://www.orwel.io/docs/concepts/personalities/anxious.md): Worried or hesitant.
- [Playful](https://www.orwel.io/docs/concepts/personalities/playful.md): Fun-seeking, non-linear.
- [Engaged](https://www.orwel.io/docs/concepts/personalities/engaged.md): Deeply involved and committed.
- [Rate Limiting](https://www.orwel.io/docs/concepts/rate-limiting.md): Understand rate limits and how to handle them
- [Pagination](https://www.orwel.io/docs/concepts/pagination.md): Working with paginated API responses
- [Error Handling](https://www.orwel.io/docs/concepts/errors.md): Every error the Orwel REST API returns: the response format, each error code with its cause and fix, rate limit headers, and which requests are safe to retry.
- [API Reference](https://www.orwel.io/docs/api-reference/introduction.md): Complete reference for the Orwel API
- [List Leads](https://www.orwel.io/docs/api-reference/leads/list.md): Retrieve a paginated list of leads for your workspace
- [Get Lead](https://www.orwel.io/docs/api-reference/leads/get.md): Retrieve a specific lead by ID
- [Create Lead](https://www.orwel.io/docs/api-reference/leads/create.md): Create a new lead in your workspace
- [Update Lead](https://www.orwel.io/docs/api-reference/leads/update.md): Update an existing lead
- [List Users](https://www.orwel.io/docs/api-reference/users/list.md): Retrieve a paginated list of workspace members
- [Get User](https://www.orwel.io/docs/api-reference/users/get.md): Retrieve a specific workspace member by ID
- [List Identities](https://www.orwel.io/docs/api-reference/identities/list.md): Retrieve a paginated list of visitor identities
- [Get Identity](https://www.orwel.io/docs/api-reference/identities/get.md): Retrieve a specific visitor identity by ID
- [Create Identity](https://www.orwel.io/docs/api-reference/identities/create.md): Create a new visitor identity
- [Update Identity](https://www.orwel.io/docs/api-reference/identities/update.md): Change the name, traits, favorite flag or last seen date of a visitor identity, for example to sync CRM data back into Orwel. Only the fields you send are changed.
- [Get Personalities](https://www.orwel.io/docs/api-reference/identities/personalities.md): Retrieve personalities for a specific identity
- [Get Activity](https://www.orwel.io/docs/api-reference/identities/activity.md): Retrieve activity logs for a specific identity
- [List Companies](https://www.orwel.io/docs/api-reference/companies/list.md): Retrieve a paginated list of companies
- [Get Company](https://www.orwel.io/docs/api-reference/companies/get.md): Retrieve a specific company by ID
- [List Visitor Lists](https://www.orwel.io/docs/api-reference/lists/list.md): Retrieve a paginated list of visitor lists (segments)
- [List Campaigns](https://www.orwel.io/docs/api-reference/campaigns/list.md): Ad campaigns of your workspace (Google Ads, Meta Ads) with impressions, clicks, cost, conversions and CTR over the last days.
- [List Conversions](https://www.orwel.io/docs/api-reference/conversions/list.md): Every conversion of your workspace, newest first, with the lead, identity and session it belongs to. Use the id to sync conversions to a CRM or warehouse without duplicates.
- [Get Conversion](https://www.orwel.io/docs/api-reference/conversions/get.md): One conversion by id, with its lead, identity, session, properties and page.
- [Generate Report](https://www.orwel.io/docs/api-reference/reports/create.md): Build a report for a date range: visitors, leads, conversion rate, lead quality, top leads, traffic by country, plus a written summary and action plan.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.