pentacent/keila

Add Campaign Analytics API

Open

#450 opened on Jul 12, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Elixir (2,092 stars) (147 forks)batch import
enhancementgood first issueready to implement

Description

I'm working on a prometheus exporter for Keila so we can visulise emails etc in Grafana.

The output of the API on the most recent docker container does not include any stats, so we cannot get a graph of opens/delivers/etc.

Contributor guide

Tech stack
elixirprometheusgrafanarest api
Domain
backendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
ElixirPhoenix framework basicsHTTP API design
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the existing Keila API endpoints in the controller layer (likely Phoenix Router/Controller files). Focus on the campaign related controller to understand how data is currently served. Then, add a new endpoint that returns campaign analytics (opens, clicks, deliveries) in a format compatible with Prometheus metrics. Consider whether to use the Prometheus Elixir client library. Check if there is an existing metrics module in the codebase. The issue mentions the Docker container does not include stats, so ensure the new endpoint can be exposed properly in production.