Integrate Rybbit

Open your Rybbit dashboard. The Site ID is in the tracking settings of your site.

Yes. Set the Script URL on the Tracking tab to the script.js URL of your instance, for example https://analytics.example.com/api/script.js.

Create an API key in Rybbit (Organization settings, API keys). Enter it on the Dashboard tab of the plugin settings and save. Use "Test connection" to check the key. After this, a widget appears on the WordPress dashboard and a new page at Dashboard > Rybbit Analytics.

Rybbit Cloud offers API keys on the Standard plan and above. The Free and Basic plans have no API keys. Self-hosted instances have no such limit. The tracking works on every plan. Only the dashboard needs an API key.

Read access to "Analytics". If you create the key without restrictions, it works too. If you restrict the key to some resources, select "Analytics" with "read". Without it, Rybbit rejects the requests and the plugin shows the missing permission. The "Open Rybbit" button on the analytics page also needs "Sites" with "read". The plugin reads the number of your site from the site settings. Without this permission, the button opens the start page of Rybbit.

The plugin sends the key only from your server to the Rybbit API. It never sends the key to a browser, and it does not show the saved key again. For more safety, define the key in wp-config.php: define( 'INTEGRATE_RYBBIT_API_KEY', 'your-key' );. This key replaces the key from the settings.

The plugin keeps the API answers for 10 minutes by default. This saves API requests, which matters on plans with request limits. Change the time on the Dashboard tab, or use "Clear cache". The count of visitors online is cached for one minute at most.

Only users who can manage the plugin settings (manage_options). Use the integrate_rybbit_dashboard_capability filter to change this.

Administrators are excluded by default. Change this on the Tracking tab. Ad blockers and browser privacy features can also block the tracking script. The Debug tab shows if your user is excluded by role.

Yes. The script tag is the same for all visitors. User identification runs only for logged-in users, and page cache plugins usually do not cache pages for logged-in users. After a logout, the plugin marks the next page as not cacheable, because this page clears the Rybbit user ID.

User identification is off by default. If you turn it on, Rybbit receives a user ID for logged-in users. It also receives the roles, username and display name of the user. Full mode also sends the cleartext email. Make sure that you have a legal basis for this and update your privacy policy. The pseudonymized mode does not send the cleartext email, but username and display name are still personal data. To send less data, remove traits with the integrate_rybbit_identify_traits filter. The HMAC strategy gives a user ID that does not show the WordPress user ID. It uses the security keys of the site. If you change these keys, all users get a new ID in Rybbit.

Go to the Custom Events tab and click "Add event rule". Enter a CSS selector, for example .buy-button, and an event name, for example buy_click. Optionally add properties, one key=value pair per line. When a visitor clicks the element, or an element inside it, the plugin sends the event to Rybbit. Properties are sent as text. You can add up to 50 rules. Visitors with an excluded role do not send events. You can also use the data-rybbit-event and data-rybbit-prop-* attributes in your HTML. Rybbit reads them without this plugin.

Add the shortcode [rybbit_optout] or the block "Rybbit Opt-out" to a page, for example your privacy policy. The visitor sees a status text and a button. A click turns the analytics off for this browser. Another click turns it on again. The choice is saved in the local storage of the browser under the key disable-rybbit. It applies to this website and this browser only. It takes effect on the next page load. The shortcode needs a Site ID. Without a Site ID, only administrators see a notice.

The opt-out uses a feature of the Rybbit tracking script (version 1.1.0 or newer). Rybbit Cloud has this feature. Old self-hosted instances may not have it. Update your instance if the opt-out has no effect. If you set data-namespace with the integrate_rybbit_script_attributes filter, the plugin uses the same namespace for the storage key (disable-<namespace>). A visitor who clears the browser data also clears the opt-out.

The settings stay in the database by default. To remove them, enable "Delete all plugin data on uninstall" on the Maintenance tab before you delete the plugin.

The plugin sets one technical cookie (rybbit_clear_user_id) when a user logs out. The next page view clears the Rybbit user ID and deletes the cookie. If user identification is active, the plugin also stores a small value in the local storage of the browser. This prevents duplicate identify requests. If a visitor turns the analytics off with the opt-out button, the plugin stores the key disable-rybbit in the local storage of the browser. For the data that the Rybbit script stores in the browser, see the Rybbit documentation.