module BWAPI::Client::Projects::Data::Volume

Volume module for projects/data/volume endpoints

Public Instance Methods

data_volume_date_ranges_days(project_id, opts = {}) click to toggle source

Get all chart data for date ranges broken down by days

@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [Hash] filter The filters to apply @option opts [Array] dateRanges Date range ids @return [Hash] All Chart data mentions

# File lib/bwapi/client/projects/data/volume.rb, line 14
def data_volume_date_ranges_days(project_id, opts = {})
  get "projects/#{project_id}/data/volume/dateRanges/days", opts
end
data_volume_queries_top_sites(project_id, opts = {}) click to toggle source

Get a sub (top 10, by volume) items of the sites dimension

@param project_id [Integer] Id of project @option opts [Hash] filter The filters to apply

# File lib/bwapi/client/projects/data/volume.rb, line 22
def data_volume_queries_top_sites(project_id, opts = {})
  get "projects/#{project_id}/data/volume/queries/topsites", opts
end
data_volume_top_authors_queries(project_id, opts = {}) click to toggle source

Get top authors for given query IDs

@param project_id [Integer] Id of project @option opts [Hash] filter The filters to apply @option opts [Integer] limit The limit to return @option opts [String] orderBy Parameter to sort by @option opts [String] orderDirection Direction of sort

# File lib/bwapi/client/projects/data/volume.rb, line 59
def data_volume_top_authors_queries(project_id, opts = {})
  get "projects/#{project_id}/data/volume/topauthors/queries", opts
end
data_volume_top_facebook_users_queries(project_id, opts = {}) click to toggle source

Returns top facebook users for given query IDs

TODO: Add parameters documentation

# File lib/bwapi/client/projects/data/volume.rb, line 88
def data_volume_top_facebook_users_queries(project_id, opts = {})
  get "/projects/#{project_id}/data/volume/topfacebookusers/queries", opts
end
data_volume_top_sites_queries(project_id, opts = {}) click to toggle source

Get top sites for given query IDs

@param project_id [Integer] Id of project @option opts [Hash] filter The filters to apply @option opts [Integer] limit The limit to return @option opts [String] orderBy Parameter to sort by @option opts [String] orderDirection Direction of sort

# File lib/bwapi/client/projects/data/volume.rb, line 70
def data_volume_top_sites_queries(project_id, opts = {})
  get "projects/#{project_id}/data/volume/topsites/queries", opts
end
data_volume_top_tweeters_queries(project_id, opts = {}) click to toggle source

Get top tweeters for given query IDs

@param project_id [Integer] Id of project @option opts [Hash] filter The filters to apply @option opts [Integer] limit The limit to return @option opts [String] orderBy Parameter to sort by @option opts [String] orderDirection Direction of sort

# File lib/bwapi/client/projects/data/volume.rb, line 81
def data_volume_top_tweeters_queries(project_id, opts = {})
  get "projects/#{project_id}/data/volume/toptweeters/queries", opts
end
data_volume_topics_compare(project_id, criteria, opts = {}) click to toggle source

Get a list of topics compared by criteria using two different values for that criteria

@param project_id [Integer] Id of project @param criteria [String] The comparison criteria @option opts [String] criteriaValue1 Value one for criteria @option opts [String] criteriaValue2 Value one for criteria @option opts [Hash] filter The filters to apply @option opts [Float] minDifference The minimum criteria difference for a topic to be returned @option opts [Integer] minVolume The minimum volume (number of mentions) for a topic to be returned @option opts [Integer] limit The limit to return @option opts [Integer] sampleSize The sample size

# File lib/bwapi/client/projects/data/volume.rb, line 37
def data_volume_topics_compare(project_id, criteria, opts = {})
  get "projects/#{project_id}/data/volume/topics/compare/#{criteria}", opts
end
data_volume_topics_queries(project_id, opts = {}) click to toggle source

Get top topics for given query IDs

@param project_id [Integer] Id of project @option opts [Hash] filter The filters to apply @option opts [Integer] limit The limit to return @option opts [String] orderBy Parameter to sort by @option opts [String] orderDirection Direction of sort

# File lib/bwapi/client/projects/data/volume.rb, line 48
def data_volume_topics_queries(project_id, opts = {})
  get "projects/#{project_id}/data/volume/topics/queries", opts
end