Module: BWAPI::Client::Projects::Data::Headlines

Included in:

BWAPI::Client::Projects::Data

Defined in:

lib/bwapi/client/projects/data/headlines.rb

Overview

Headlines module for projects/data/headlines endpoints

Instance Method Summary

• #data_headlines(project_id, opts = {}) ⇒ Hash

  Get mention headlines that fall within the submitted filters.

Instance Method Details

#data_headlines(project_id, opts = {}) ⇒ Hash

Get mention headlines that fall within the submitted filters

Parameters:

• project_id (Integer) —

  Id of project

• opts (Hash) (defaults to: {}) —

  options hash of parameters

Options Hash (opts):

• filter (Hash) —

  The filters to apply

Returns:

• (Hash) —

  All Mention headlines

# File 'lib/bwapi/client/projects/data/headlines.rb', line 13

def data_headlines(project_id, opts = {})
  get "projects/#{project_id}/data/headlines", opts
end