howdyai / botmetrics

Analytics and Engagement for Makers and Marketers of Chat and Voice bots

Botmetrics

Botmetrics is the easy, secure, open-source way for you to measure and engage with your chat-bot users.

Botmetrics works natively with Messenger, Slack and Kik bots with support for other messaging platforms coming soon.

Deploy to AWS

Analytics

With Botmetrics, you can get analytics for your bot with very little code, and native SDKs available in

• Node.JS
• Ruby
• Go

Insights

You can gain more insight into the users using your bot and perform sophisticated queries to find out who they are.

Notifications

You can gain more insight into the users using your bot and send then re-engagement notifications based on pre-selected criteria.

Installation

• Heroku
• AWS
• Linux

Updating your Installation

• Heroku
• AWS

Development

1. cp .env-example .env
2. Start Redis & Postgres (there's a ./script/redis and ./script/dbstart command that lets you do this easily)
3. Run ./script/dbreset to reset the database (creates a new one, loads schema and runs rake db:seed)
4. Run ./script/server to start the server
5. Visit localhost:3000

Contributing

• Join the Slack channel to ask questions
• Open a GitHub Issue for bugs/feature requests
• Create a GitHub Pull Request to submit patches

Wiki

Extra information can be found in the wiki.

Roadmap

The Botmetrics Roadmap can be seen here.

CircleCI

Stay Connected

Follow Botmetrics on Twitter to get the latest updates.

Read the Botmetrics Blog for more How tos, success stories and more.

botmetrics's Issues

Support Rich Notifications: Images, Audio, Video (aka Attachments)

I'd love to send audio and video content, too, as well as generic templates. Actually I can only send text messages, which is working pretty well by the way.

Are you planning to enable users to send these content-types, too?

Extend bot user enrichment

Currently the user enrichment endpoint only supports updating the timezone attribute of the user. It would be great if we could retroactively extend this endpoint to include user attributes such as first_name, last_name, email, ref, and gender

Remove unneeded gems

There are a few gems that are no longer being used or needed in the Gemfile.

Let's 86 those punks!

Add ability to delete bots

Support for saved insights

Update Readme

Hi!
There are a few things I found that weren't exactly following from the Readme.
For e.g, I didn't realize database.yml.example also had to be copied the same as .env-example

I would like to take this up if it's alright. 😄

Add Event Tracking API for Slack (support new events API)

• Support for different types of rich messages (links, with buttons, etc.)
• Add support for event tracking for button clicks (link to previous message somehow?)
• Show new messages in dashboard
• Link to insights/notifications

Transcripts not available in repository

The transcripts functionality seems to be missing from the repo version as opposed to the getbotmetrics.com version
Is this something that will be available?

Support for Web Chat Bots

Does Botmetrics support web chat bots? If so how to enable them?

I have deployed the open-source botmerics server and could not find option to enable it.

Transcripts not available in repo

The transcripts functionality seems to be missing from the repo version as opposed to the getbotmetrics.com version

Is this something that will be available?

not able to view user names, profile pictures after self hosting in heroku

Update Dockerfile

• Use heroku/cedar base image
• Update docker-compose.yml

Add ability to edit access token

I accidently changed access token for my bot and now i lose the ability to use notification ( it's using invalid access token )

Add support for one-click deployments to MS Azure

We want botmetrics to be easy to deploy to Azure Services.

The architecture is described here: https://blog.getbotmetrics.com/scalable-conversational-analytics-with-botmetrics-and-docker-ie-more-cowbell-c0f621ebde92#.7igvwwiyo

Add support for one-click deployments to Google Cloud

We want botmetrics to be easy to deploy to Google Cloud.

The architecture is described here: https://blog.getbotmetrics.com/scalable-conversational-analytics-with-botmetrics-and-docker-ie-more-cowbell-c0f621ebde92#.7igvwwiyo

Maybe we can accomplish this with a Google Cloud Manager Template?
https://cloud.google.com/deployment-manager/

Rich metrics must be present in notifications/insights

Add Rollbar configuration

Since the default (free) exception tracker is Rollbar, we need to make sure Rollbar is correctly configured

Allow Link Tracking

Currently, botmakers do not have a way to know when links are clicked by users in the chat window. We can provide link click analytics by wrapping the link and redirecting the user.
This will be helpful in understanding user link click conversions.

Must:

• Track link + bot_id + user_id (per bot)
• Use existing event architecture

NIce to Have:

• Shortened Links

Add instructions on how to install manually

ArgumentError while adding Team member

I get an error from devise when adding a new team member:

Missing host to link to! Please provide the :host parameter, set default_url_options[:host], or set :only_path to true
Extracted source (around line #3):              
<p><%= t("devise.mailer.invitation_instructions.hello", email: @resource.full_name) %></p>

<p><%= t("devise.mailer.invitation_instructions.someone_invited_you", url: root_url, inviter: @resource.invited_by.full_name) %></p>

<p><%= link_to t("devise.mailer.invitation_instructions.accept"), accept_invitation_url(@resource, :invitation_token => @token) %></p>

app/views/devise/mailer/invitation_instructions.html.erb:3:in `_app_views_devise_mailer_invitation_instructions_html_erb__455187421660232892_69842160299940'
app/controllers/invitations_controller.rb:38:in `add_to_bot!'
app/controllers/invitations_controller.rb:13:in `block in create'
app/controllers/invitations_controller.rb:12:in `create'

Could we set this up during sign up when the app asks for the domain?

Retention Analysis

Add support for one-click deployments to AWS

Add ability to delete custom dashboards

Show zero percent growth instead of infinite

When there is no previous data Inf% is displayed. Displaying 0% might be a more user friendly metric.

Possible solution in /app/lib/growth_calculator.rb

def call
  previous, current = values[position-1..position]

  return nil if current == 0

  growth = (current - previous).to_f / previous
  growth = 0.0 if growth.infinite?
  growth
end

Add support for "per-hour" views on dashboards

Users can currently view graphs for metrics on a per day basis.
Some users need finer granularity within a day.

Must:
Users should be able to view all graphs on a hourly basis.

Should:
TIme should be users local time

May:
Provide finer grained detail than an hour

Support for funnels

Add support for events to be associated with more than one user

Dockerize Bot Metrics

Let's put this in a container. 👯

Custom events must be present in notifications/insights

TODO:

• Query must be linked to a custom dashboard (Query has_one Dashboard)
• Dropdown for the Insights must contain custom dashboards
• Should be able to find based on time range

Add uid to Events

This will represent a unique event

• In the case of Slack this will combination of channel_id + timestamp
• In the case of Facebook, this will be mid + seq
• In the case of Kik, this will be chat_id

Can't verify CSRF token authenticity

Hello everyone,

I'm deploying Botmetrics api on a private server, so I change the API ENV URL, but when I track POST calls I get :
Started POST "/bots/68fd2d3060ad/events" for 54.161.121.186 at 2016-09-30 10:31:44 +0000 10:31:44 web.1 | Processing by EventsController#create as JSON 10:31:44 web.1 | Parameters: {"event"=>"{\"object\":\"page\",\"entry\":[{\"id\":\"145584749232568\",\"time\":1475231503927,\"messaging\":[{\"sender\":{\"id\":\"1158741300867145\"},\"recipient\":{\"id\":\"145584749232568\"},\"timestamp\":0,\"delivery\":{\"mids\":[\"mid.1475231503541:f9d95116dbe82db360\"],\"watermark\":1475231503673,\"seq\":341}}]}]}", "bot_id"=>"68fd2d3060ad"} 10:31:44 web.1 | Can't verify CSRF token authenticity 10:31:44 web.1 | Completed 401 Unauthorized in 1ms (ActiveRecord: 0.0ms)