module BWAPI::Client::Projects::Data::Mentions

Mentions module for projects/data/mentions endpoints

Public Instance Methods

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

Get mentions that fall within the submitted filters

@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [Hash] filter The filters to apply @option opts [Integer] page Page of projects to retrieve @option opts [Integer] pageSize Results per page of results @option opts [String] orderBy Parameter to sort by @option opts [String] orderDirection Direction of sort @option opts [Integer] orderByCategory Category to sort by when orderBy category @return [Hash] All Mentions

# File lib/bwapi/client/projects/data/mentions.rb, line 20
def data_mentions(project_id, opts = {})
  get "projects/#{project_id}/data/mentions", opts
end
data_mentions_count(project_id, opts = {}) click to toggle source

Retrieve the total count of mentions for the requested queries

TODO: Add parameters documentation

# File lib/bwapi/client/projects/data/mentions.rb, line 27
def data_mentions_count(project_id, opts = {})
  get "/projects/#{project_id}/data/mentions/count", opts
end
data_mentions_facebook_comments(project_id, opts = {}) click to toggle source

Get mentions that fall within the submitted filters for all facebook comments

@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [Hash] filter The filters to apply @option opts [Integer] page Page of projects to retrieve @option opts [Integer] pageSize Results per page of results @option opts [String] orderBy Parameter to sort by @option opts [String] orderDirection Direction of sort @option opts [Integer] orderByCategory Category to sort by when orderBy category @return [Hash] All Mentions

# File lib/bwapi/client/projects/data/mentions.rb, line 97
def data_mentions_facebook_comments(project_id, opts = {})
  get "projects/#{project_id}/data/mentions/facebookcomments", opts
end
data_mentions_facebook_posts(project_id, opts = {}) click to toggle source

Get mentions that fall within the submitted filters for all facebook posts

@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [Hash] filter The filters to apply @option opts [Integer] page Page of projects to retrieve @option opts [Integer] pageSize Results per page of results @option opts [String] orderBy Parameter to sort by @option opts [String] orderDirection Direction of sort @option opts [Integer] orderByCategory Category to sort by when orderBy category @return [Hash] All Mentions

# File lib/bwapi/client/projects/data/mentions.rb, line 82
def data_mentions_facebook_posts(project_id, opts = {})
  get "projects/#{project_id}/data/mentions/facebookposts", opts
end
data_mentions_full_text(project_id, opts = {}) click to toggle source

Get mentions that fall within the submitted filters with full text

@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [Hash] filter The filters to apply @option opts [Integer] page Page of projects to retrieve @option opts [Integer] pageSize Results per page of results @option opts [String] orderBy Parameter to sort by @option opts [String] orderDirection Direction of sort @option opts [Integer] orderByCategory Category to sort by when orderBy category @return [Hash] All Mentions

# File lib/bwapi/client/projects/data/mentions.rb, line 52
def data_mentions_full_text(project_id, opts = {})
  get "projects/#{project_id}/data/mentions/fulltext", opts
end
data_mentions_tweets(project_id, opts = {}) click to toggle source

Get mentions that fall within the submitted filters with fulltext

@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [Hash] filter The filters to apply @option opts [Integer] page Page of projects to retrieve @option opts [Integer] pageSize Results per page of results @option opts [String] orderBy Parameter to sort by @option opts [String] orderDirection Direction of sort @option opts [Integer] orderByCategory Category to sort by when orderBy category @return [Hash] All Mentions

# File lib/bwapi/client/projects/data/mentions.rb, line 67
def data_mentions_tweets(project_id, opts = {})
  get "projects/#{project_id}/data/mentions/tweets", opts
end
update_data_mentions(project_id, opts = {}) click to toggle source

Update mentions for project

@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [Hash] List The patches to be applied @return [Hash] Updated mentions

# File lib/bwapi/client/projects/data/mentions.rb, line 37
def update_data_mentions(project_id, opts = {})
  patch "projects/#{project_id}/data/mentions", opts
end