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

Includes:
Audience, AudienceActivity, ChannelMetrics, Emoticons, Hashtags, Headlines, Impressions, MentionedAuthors, Mentions, OwnerActivity, Urls, Volume
Included in:
BWAPI::Client::Projects
Defined in:
lib/bwapi/client/projects/data.rb,
lib/bwapi/client/projects/data/urls.rb,
lib/bwapi/client/projects/data/volume.rb,
lib/bwapi/client/projects/data/audience.rb,
lib/bwapi/client/projects/data/hashtags.rb,
lib/bwapi/client/projects/data/mentions.rb,
lib/bwapi/client/projects/data/emoticons.rb,
lib/bwapi/client/projects/data/headlines.rb,
lib/bwapi/client/projects/data/impressions.rb,
lib/bwapi/client/projects/data/mentions/notes.rb,
lib/bwapi/client/projects/data/owner_activity.rb,
lib/bwapi/client/projects/data/channel_metrics.rb,
lib/bwapi/client/projects/data/audience_activity.rb,
lib/bwapi/client/projects/data/mentioned_authors.rb

Overview

Data module for projects/data endpoints

Defined Under Namespace

Modules: Audience, AudienceActivity, ChannelMetrics, Emoticons, Hashtags, Headlines, Impressions, MentionedAuthors, Mentions, OwnerActivity, Urls, Volume

Instance Method Summary collapse

Methods included from Volume

#data_volume_date_ranges_days, #data_volume_queries_top_sites, #data_volume_top_authors_queries, #data_volume_top_authors_queries_alt, #data_volume_top_sites_queries, #data_volume_top_tweeters_queries, #data_volume_topics_compare, #data_volume_topics_queries

Methods included from Urls

#data_urls

Methods included from OwnerActivity

#data_owner_activity_queries

Methods included from Mentions

#data_mentions, #data_mentions_facebook_comments, #data_mentions_facebook_posts, #data_mentions_full_text, #data_mentions_tweets, #update_data_mentions

Methods included from Mentions::Notes

#create_mention_note, #mention_note, #patch_mention_note, #update_mention_note

Methods included from MentionedAuthors

#data_mentioned_authors

Methods included from Impressions

#data_impressions_queries

Methods included from Hashtags

#data_hashtags

Methods included from Emoticons

#data_emoticons

Methods included from ChannelMetrics

#data_channel_metrics_queries

Methods included from AudienceActivity

#data_audience_activity_queries

Methods included from Audience

#data_audience_queries

Instance Method Details

#data(project_id, aggregate, dimension_one, dimension_two, opts = {}) ⇒ Hash

Get all chart data for the requested dimensions

Parameters:

  • project_id (Integer) —

    Id of project

  • aggregate (String) —

    Aggregate value

  • dimension_one (String) —

    Dimension 1 value

  • dimension_two (String) —

    Dimension 2 value

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

    options hash of parameters

Options Hash (opts):

  • filter (Hash) —

    The filters to apply

Returns:

  • (Hash) —

    All Chart data mentions



28
29
30
 
# File 'lib/bwapi/client/projects/data.rb', line 28

def data(project_id, aggregate, dimension_one, dimension_two, opts = {})
  get "projects/#{project_id}/data/#{aggregate}/#{dimension_one}/#{dimension_two}", opts
end

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

Get headline figures for specified channels

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) —

    Headline figures for spedified channels



38
39
40
 
# File 'lib/bwapi/client/projects/data.rb', line 38

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