Skip to content

Configuration

Ariel is looking for work! edited this page Aug 8, 2023 · 3 revisions

DaisyUI Theme

To make Ahoy Captain as easy to drop into any Rails 6+ app as possible, we have decided to pull tailwind and daisyUI using a CDN. This means that your dashboard will look great, regardless of whether you use importmaps, webpacker, esbuild, or something else.

You can further customize the dashboard's theme by setting the config.theme option to any of the different themes that daisyUI defines.

Goals

You can use goals to keep track of things you want people to do on your website, like signing up for a newsletter or buying something. These actions could be clicking a "Download" button, getting a trial account, or making a purchase.

When you set up goals, you can count how many times these actions happen, see where people came from before doing them, and find out which pages are most popular for these actions.

Setting up a goal in your Ahoy Captain dashboard is as simple updating your config file with a :unique_goal_id, label that will be shown in your dashboard, and name of the field used in your database table to track the goal, e.g.:

config.goal :appointment_created do
  label "Appointment Created"
  name "$appointments.created_at"
end

Alternatively, you can direct Ahoy Captain to use a particular query to identify your goal, e.g.:

config.goal :appointment_paid do
  label "Appointment Paid"
  query do
    ::Ahoy::Event.where(...)
  end
end

Funnels

You can use our multi-step funnel analysis to see how visitors move from a one action, like landing on starting page, to completing a desired goal, like signing up for your service. This helps you find problems, improve your site, and guide more people towards completing your goals.

Funnels help you study how users move through your website and its pages. The conversion rate tells you the percentage of visitors who started the process and finished the action. By looking at the percentage of visitors who drop off at each step of the funnel, you can figure out where you're losing the most people.

Currently, you can use goals to create a funnel. To define a funnel in your config, use your previously defined goals, e.g.:

config.funnel :appointments do
  label "Appointment Workflow"
  goal :appointment_created
  goal :appointment_paid
end

Remember -- the order you list your goals matters!

Widgets

Since some widgets are more expensive than others, you can disable them in the config file.

The widgets that are currently supported by the dashboard are:

  • sources
  • campaigns.utm_medium
  • campaigns.utm_source
  • campaigns.utm_term
  • campaigns.utm_content
  • campaigns.utm_campaign
  • top_pages
  • entry_pages
  • landing_pages
  • locations.countries
  • locations.regions
  • locations.cities
  • devices.browsers
  • devices.operating_systems
  • devices.device_types

Event tracking

Models

Time periods

Clone this wiki locally