Get high-level analytics metrics for a site including sessions, pageviews, users, bounce rate, and session duration

Get time-series analytics data broken into configurable time buckets for trend analysis

Get dimensional breakdown of metrics by a specific parameter (browser, country, pathname, etc.)

Get the count of currently active visitors on the site

Get cohort-based retention analysis data

Get the most common page navigation paths (user journeys) within sessions

Get a paginated list of sessions with analytics data

Get detailed information about a specific session including all events and pageviews

Get aggregated session locations with coordinates for map visualization

Get a paginated list of events (pageviews, custom events, and outbound clicks)

Get a list of unique custom event names with their occurrence counts

Get property key-value pairs for a specific event name with occurrence counts

Get a list of outbound link clicks with their occurrence counts

Get a paginated list of users with analytics data

Get session data for a specific user

Get the number of sessions per day for a specific user

Get detailed user information including profile traits and linked devices

Link an anonymous visitor to a known user ID and optionally merge profile traits. Requires the users:write scope.

Replace the profile traits of an identified user. WARNING: this is a wholesale replacement, not a merge — include every trait you want to keep. Max 2KB serialized. Requires the users:write scope.

Permanently delete a user and all their data (events, session replays, profile, aliases) — GDPR erasure. DESTRUCTIVE and IRREVERSIBLE; deletion runs asynchronously. Requires org admin/owner role and the users:write scope.

Get a paginated list of goals with their conversion metrics

Get sessions that completed a specific goal

Create a new goal for tracking conversions (path-based or event-based)

Update an existing goal configuration

Delete a goal permanently

Get all saved funnels for a site

Analyze a funnel and get step-by-step conversion data

Get sessions that reached or dropped off at a specific funnel step

Create or update a saved funnel

Delete a saved funnel permanently

Get Core Web Vitals and performance metrics overview (LCP, CLS, INP, FCP, TTFB percentiles)

Get performance metrics over time for trend analysis

Get performance metrics broken down by a specific dimension (pathname, country, browser, etc.)

Get unique error messages with occurrence and session counts

Get individual error occurrences with full context including stack traces

Get error occurrence trends over time

Get all organizations the authenticated user is a member of

Get members of a specific organization

Add a member to an organization

List teams in an organization, including their members and site assignments. Requires the org:read scope.

Create a team in an organization, optionally assigning members and sites. Requires org admin/owner role and the org:write scope.

Update a team. WARNING: memberUserIds and siteIds are replaced wholesale when provided — include the full desired lists. Requires org admin/owner role and the org:write scope.

Delete a team permanently. Requires org admin/owner role and the org:write scope.

Restrict or unrestrict which sites an organization member can access. memberId is the membership record ID from rybbit_get_organization_members (not the user ID). Requires org admin/owner role and the org:write scope.

Create a new site in an organization

Get site details and configuration

Update site configuration

Delete a site permanently

Get the list of IP addresses excluded from tracking for a site. Requires the sites:read scope.

Get the list of country codes excluded from tracking for a site. Requires the sites:read scope.

Get the private-link sharing configuration for a site. Requires org admin/owner role (admin-gated upstream) and the sites:write scope.

Run a read-only ClickHouse SQL query against your analytics events. Query the scoped_events table only (pre-filtered to sites your API key can access). Server-enforced limits: SELECT/WITH-SELECT statements only; max 1,000 result rows; 10-second execution cap; query length up to 20,000 chars; no semicolons; no quoted identifiers; DDL/DML keywords and remote table functions are blocked. Requires the sql:read scope. Call rybbit_get_query_schema first to see available columns. Omit siteId to query across all accessible sites in the organization.

Get the ClickHouse column schema of the scoped_events table for use with rybbit_run_query. Returns column names, types, and usage notes. No API request is made.

Send a tracking event (pageview, custom event, performance, error, or outbound link)

Send a batch of 1-50 tracking events in one call. Each event has the same shape as rybbit_track_event. Events are sent sequentially; the result reports per-event success/failure. Note: siteId is the tracking site ID from your Rybbit tracking snippet. An API key with the ingest:write scope marks events as trusted server-side ingestion.

Get a one-call analytics digest for a site: overview metrics plus top pages, referrers, countries, device types, custom events, and current live visitor count. Fans out to ~7 API requests internally — prefer this over calling each tool separately.

Compare site overview metrics between a date range and the equal-length preceding period. Returns current values, previous values, and per-metric absolute and percent changes (percentChange is null when the previous value was 0).