Intel

:monkey_face: Search analytics made easy

:cupid: An amazing companion to Searchkick

Works with Rails 3.1+ and any search engine, including Elasticsearch, Sphinx, and Solr

Get Started

Add this line to your application’s Gemfile:

gem "intel"

And run the generator. This creates a migration to store searches.

rails generate intel:install
rake db:migrate

Next, add the dashboard to your config/routes.rb.

mount Intel::Engine, at: "admin/intel"

Be sure to protect the endpoint in production - see the Authentication section for ways to do this.

Track searches by creating a record in the database.

Intel::Search.create(
  search_type: "Item", # typically the model name
  query: "apple",
  results_count: 12
)

With Searchkick, you can use the track option to do this automatically.

Item.search "apple", track: true

If you want to track more attributes, add them to the intel_searches table. Then, pass the values to the track option.

Item.search "apple", track: {user_id: 1, source: "web"}

It’s that easy.

Tracking conversions is super important.

First, define your conversion metric. This is specific to your application.

Next, when a user searches, keep track of the search id.

@items = Item.search "apple", track: true
@items.search.id # returns search id

When a user converts, mark it.

search = Intel::Search.find params[:search_id]
search.converted_at = Time.now
search.save

Better yet, record the result that converted.

item = Item.find params[:item_id]
search.convertable = item
search.save

The item will appear in the live stream. Add the intel_name method to your model to change what is displayed.

class Item < ActiveRecord::Base
  def intel_name
    title # use the title method
  end
end

Don’t forget to protect the dashboard in production.

Set the following variables in your environment or an initializer.

ENV["INTEL_USERNAME"] = "andrew"
ENV["INTEL_PASSWORD"] = "secret"

authenticate :user, lambda{|user| user.admin? } do
  mount Intel::Engine, at: "admin/intel"
end

To change the time zone, create an initializer config/initializers/intel.rb with:

Intel.time_zone = "Pacific Time (US & Canada)" # defaults to Time.zone

Everyone is encouraged to help improve this project. Here are a few ways you can help: