Project

fathom_analytics

0.0
Low commit activity in last 3 years
No release in over a year
fathom_analyticsgpoisoned/fathom_analyticsHomepageDocumentationSource Code
Ruby client for Fathom Analytics server.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
3,769
Stars
0
Forks
0
Watchers
2
 Releases
Current version
1.0
Total releases
3
First release
2020-07-01
Latest release
2023-08-29
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
1
Merged Pull Requests
13
Pull Request Acceptance Rate
86%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2020-11-13
Reverse Dependencies
0

 Dependencies

Development

byebug
~> 11.1, >= 11.1.3
dotenv
~> 2.7, >= 2.7.5
pry-byebug
~> 3.9
rake
~> 12.0
rspec
~> 3.0
vcr
~> 6.0
webmock
~> 3.8, >= 3.8.3

Runtime

faraday
~> 2.7, >= 2.7.10
 Project Readme

CI Specs Gem Version

Fathom Analytics Ruby Client

A Ruby interface to Fathom Analytics server.

Installation

Add this line to your application's Gemfile:

gem 'fathom_analytics'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install fathom_analytics

Usage

Creating an instance of the API client:

api = FathomAnalytics::Api.new(url: 'https://example.com', email: '', password: '')

Authentication:

api.authenticate

Note: Any other api call without prior authentication will implicitly call authenticate.

Get all sites:

api.sites

Add a new site:

api.add_site(name: 'demo')

Remove a site:

api.remove_site(id: 1)

Get realtime site stats:

api.site_realtime_stats(id: 1)

Get site stats:

api.site_stats(id: 1, from: 1577862000, to: 1609484399)

Get aggregated site stats:

api.site_agg_stats(id: 1, from: 1577862000, to: 1609484399)

Get aggregated page stats:

api.page_agg_stats(id: 1, from: 1577862000, to: 1609484399)

Get aggregated page views:

api.page_agg_page_views_stats(id: 1, from: 1577862000, to: 1609484399)

Get aggregated referrer stats:

api.referrer_agg_stats(id: 1, from: 1577862000, to: 1609484399)

Get aggregated referrer page views:

api.referrer_agg_page_views_stats(id: 1, from: 1577862000, to: 1609484399)

Pagination

Pagination is supported through offset and limit params.

api.page_agg_page_views_stats(id: 1, from: 1577862000, to: 1609484399, offset: 10, limit: 10) # Second page

The default values for paginations params are as follows:

  1. limit = 50
  2. offset = 0

Handling API Errors

The api call will raise an error FathomAnalytics::Error when it fails.

begin
  api.authenticate
rescue FathomAnalytics::Error => e
  # Log and handle the error
end

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

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