PlacesScout

A gem to interact with the Places Scout API. https://www.placesscout.com/api Check the usage section for what's currently implemented.

Installation

Add this line to your application's Gemfile:

gem 'places_scout'

And then execute:

$ bundle

Or install it yourself as:

$ gem install places_scout

Usage

You can add :size & :page as parameters to grab specific size/page to the calls below. The maximum size supported by the API is 100.

get_ranking_reports() # Defaults to returning all pages with 100 results each
get_ranking_reports(:size => '10') # Returns all pages with 10 results each
get_ranking_reports(:size => '5', page => '5') # Returns only the 5th page

Connecting to the API

testcon = PlacesScout::Api.new("username", "password")

Clients

testcon.get_clients()   # Grab all clients. 
testcon.get_clients(:clientid => 'client-id') #Grab specific client

Locations

testcon.get_client_locations()   # Grab all client locations. 
testcon.get_client_locations(:clientid => 'client-id') #Grab locations for specific client
testcon.get_client_locations(:locationid => 'location-id') #Grab by location id

Folders

testcon.get_client_folders()#Grab all client folders.
testcon.get_client_folders(:clientid => 'client-id') #Grab folder off client id

Rank Reports

testcon.get_ranking_reports #Grab a list of all ranking reports. 
testcon.get_ranking_reports(:all => true) #Grab all ranking report data. 
testcon.get_ranking_reports(:clientid => 'client-id') #Grab Rank reports for a specific client
testcon.get_ranking_reports(:clientid => 'client-id', :locationid=> 'location-id') # Grab specific location for specific client
testcon.get_ranking_reports(:reportid => 'report-id') #Grab a specific ranking report
testcon.get_ranking_reports(:reportid => 'report-id', :historical => true) #Return chart for average rankings over time 
testcon.get_ranking_reports(:reportid => 'report-id', :historical => true, :keywords => true) #Return chart for keyword rankings over time
testcon.get_ranking_reports(:reportid => 'report-id', :rundates => true) # Return run dates and ID's for a report
testcon.get_ranking_reports(:reportid => 'report-id', :runs => true) #Grab the runs for a report
testcon.get_ranking_reports(:reportid => 'report-id', :runs => true, :runid => 'run-id') #Grab a specific report run
testcon.get_ranking_reports(:reportid => 'report-id', :runs => true, :runid => 'run-id', :keywordresults => true) #Grab a specific report run keyword results
testcon.get_ranking_reports(:reportid => 'report-id', :runs => true, :runid => 'run-id', :keywordresults => true, :keywordresultsid => 'keyword-results-id') #Grab a specific keyword result for a specific report run 
testcon.get_ranking_reports(:reportid => 'report-id', :runs => true, :runid => 'run-id', :keywordserpscreenshot => 'adhesion treatment' , :googlelocation => 'San Luis Obispo, CA') #Google Organic SERP Page
testcon.get_ranking_reports(:reportid => 'report-id', :runs => true, :runid => 'run-id', :summary => true) # Grab summary metrics
testcon.get_ranking_reports(:reportid => 'report-id', :runs => true, :newest => true) # Grab newest if :newest => true. Grab oldest if :newest => false

Status

testcon.get_status #Grab the status of all reports

Development

After checking out the repo, run bin/setup to install dependencies. 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/mhoskiso/places_scout.

License

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