How to set up click analytics with Ahoy Email in Rails?

Install the gem, run the rails generate ahoy:clicks command, create an initializer to add a subscriber like DatabaseSubscriber, and enable the API. Then, add track_clicks to your mailers with a campaign name, as shown in the README.

Ahoy Email vs SendGrid analytics for Rails apps?

Ahoy Email offers first-party, privacy-focused analytics that keep data in-house, while SendGrid provides more comprehensive features like deliverability insights but relies on third-party data. Choose based on your need for data control versus out-of-the-box functionality.

Can Ahoy Email track email opens?

No, Ahoy Email only tracks email sends and link clicks, not opens. For open tracking, you'd need to implement additional methods or use external services, as it's not covered in the features.

How to customize UTM parameters for email campaigns with Ahoy Email?

Use the utm_params method in your mailers with custom lambdas for parameters like utm_campaign, or set global defaults in the initializer. The README provides examples for overriding defaults conditionally.

What data storage backends are supported for click analytics?

Ahoy Email supports database storage via DatabaseSubscriber, Redis with RedisSubscriber, or custom subscribers for other backends, allowing flexibility based on your app's infrastructure needs.

How to handle data retention with Ahoy Email?

You can delete older data manually using ActiveRecord queries, such as Ahoy::Message.where("sent_at < ?", 1.year.ago).in_batches.delete_all, but there's no built-in automated cleanup, so it requires custom scheduling.

Open-Awesome

ahoy_email

MITRuby

First-party email analytics for Rails applications, providing message history, UTM tagging, and click tracking.

GitHub

1.2k stars144 forks0 contributors

What is ahoy_email?

Ahoy Email is a Ruby gem that adds first-party email analytics to Rails applications. It solves the problem of tracking email performance without relying on external services by providing message history, UTM tagging, and click analytics directly within your app.

Target Audience

Rails developers building applications that send transactional or marketing emails and need to track engagement while maintaining data privacy.

Value Proposition

Developers choose Ahoy Email because it offers a privacy-focused, self-hosted alternative to third-party email analytics, with seamless Rails integration, modular features, and support for multiple data stores.

Overview

First-party email analytics for Rails

Use Cases

Best For

Rails apps needing to track email open and click rates internally
Adding UTM parameters to email links for campaign attribution
Building email analytics dashboards with first-party data
Auditing email delivery history with user associations
Tracking marketing email performance without external services
Applications with strict data privacy requirements for email analytics

Not Ideal For

Non-Rails applications or projects using other web frameworks like Django or Node.js
Teams that want plug-and-play email analytics with zero configuration, such as those using hosted services like SendGrid
High-volume email campaigns needing distributed, scalable analytics out-of-the-box without custom backend tuning
Applications requiring detailed email open tracking as part of their core analytics suite

Pros & Cons

Pros

First-Party Data Privacy

Keeps all email analytics data in-house, avoiding reliance on third-party services, which is explicitly highlighted for applications with strict privacy requirements.

Modular Feature Set

Allows independent use of message history, UTM tagging, and click analytics, as stated in the README's 'Getting Started' section, reducing bloat.

Flexible Storage Options

Supports database, Redis, or custom backends for click analytics, enabling scalability and integration with existing infrastructure, as detailed in the configuration examples.

Seamless Rails Integration

Uses Rails conventions like generators and polymorphic associations, making it easy to set up and query data, evidenced by the simple mailer method additions.

Cons

Complex Initial Configuration

Setting up click analytics requires multiple steps, including adding subscribers and enabling the API in an initializer, which can be error-prone and time-consuming.

Breaking Changes in Upgrades

Version 3.0 introduced breaking changes that broke compatibility with older links, requiring manual token management, as admitted in the 'Upgrading' section.

Limited to Rails Framework

Only compatible with Ruby on Rails applications, so it's not suitable for other web frameworks or languages, restricting its use case.

No Native Open Tracking

Focuses only on sends and clicks, lacking built-in open tracking, which is a common feature in third-party email analytics services.

Frequently Asked Questions

Related Projects

devise

Flexible authentication solution for Rails with Warden.

Stars24,356

Forks5,467

Last commit3 months ago

Postal

📮 A fully featured open source mail delivery platform for incoming & outgoing e-mail

Stars16,854

Forks1,302

Last commit5 days ago

spree

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

The administration framework for Ruby on Rails applications.

Stars9,713

Forks3,323