Module: BWAPI::Client::Brandwatch

Includes:

Become, Clients

Included in:

BWAPI::Client

Defined in:

lib/bwapi/client/brandwatch.rb,
lib/bwapi/client/brandwatch/become.rb,
lib/bwapi/client/brandwatch/clients.rb,
lib/bwapi/client/brandwatch/clients/users.rb,
lib/bwapi/client/brandwatch/clients/modules.rb

Overview

Brandwatch module for brandwatch endpoints

Defined Under Namespace

Modules: Become, Clients

Instance Method Summary

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

  Create a new data download in project.

Methods included from Clients

#brandwatch_clients, #brandwatch_create_client, #brandwatch_get_client, #brandwatch_update_client

Methods included from Clients::Modules

#brandwatch_client_modules, #update_brandwatch_client_modules

Methods included from Clients::Users

#brandwatch_create_client_user

Methods included from Become

#brandwatch_become

Instance Method Details

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

Create a new data download in project

Parameters:

• project_id (Integer) —

  Id of project

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

  options hash of parameters

Options Hash (opts):

• id (Integer) —

  Id of the data download

• queryId (Integer) —

  Id of the query

• percentComplete (Int) —

  The percentage complete of data download

• status (String) —

  The status of the download

• queryName (String) —

  The query name of the data download

• endDate (Date) —

  The end date of the data download

• requestDate (Date) —

  The request date of the data download

• downloadLinkXLS (String) —

  The link to download the XLS format

• downloadLinkCSV (String) —

  The link to download the CSV format

• additionalColumns (Array) —

  The additional columns for the data download

Returns:

• (Hash) —

  New data download

# File 'lib/bwapi/client/brandwatch.rb', line 23

def brandwatch_data_download(project_id, opts = {})
  post "brandwatch/#{project_id}/datadownload", opts
end