Simple Analytics API Ruby Gem

This is a simple wrapper to read the Simple Analytics API with Ruby. It's based on the API guide

Usage

Add this gem to your Gemfile:

gem 'simple_analytics_api'

Now you need to initialize a Client with your api_key (if the domain is not public), the user_id (required for some specific actions), and the domain you want to get stats from.

client = SimpleAnalyticsApi::Client.new(api_key: '<api_key>', user_id: '<user_id>', domain: '<domain>') 

# Test if the credentials are valid (all public domains should return true)
client.valid?
=> true

To get some actual data, you can use the run method, like this:

client.run(
  fields: %w(pageviews visitors pages), 
  filters: {
    start: '2021-01-01 00:00', 
    end: '2021-01-05 23:59'
  }
).pages
=> [#<OpenStruct value="/", pageviews=36, visitors=28>, #<OpenStruct value="/may-2020-all-stripe-data-explained-and-we-just-hit-6000-usd-mrr", pageviews=14, visitors=2>, #<OpenStruct value="/how-we-hit-our-30k-annual-recurring-revenue-milestone", pageviews=5, visitors=4>, #<OpenStruct value="/why-we-moved-our-servers-to-iceland", pageviews=5, visitors=2>, #<OpenStruct value="/april-2020-we-hit-400-paying-customers", pageviews=4, visitors=3>, #<OpenStruct value="/practical-privacy-tips-for-your-business", pageviews=2, visitors=2>]

The run command will also include some other helpful information, like this:

=> #<SimpleAnalyticsApi::Object ok=true, docs="https://docs.simpleanalytics.com/api", info="false", hostname="blog.simpleanalytics.com", url="https://blog.simpleanalytics.com", path="*", start="2021-01-01T00:00:00.000Z", end="2021-01-06T23:59:59.999Z", version=5, timezone="UTC", pageviews=66, visitors=41, pages=...the-content-that-you-see-above..., generated_in_ms=398>

You can also include a debug parameter if you want to see the final URL that is going to be called, like this:

client.run(
  fields: %w(pageviews visitors pages), 
  filters: {
    start: '2021-01-01 00:00', 
    end: '2021-01-05 23:59'
  },
  debug: true
).pages

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dailytics/simpleanalytics_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the SimpleAnalyticsApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.