Function reference • brandseyer2

Quick start These are the basic steps that you need to take in order to get data using brandseyer2. First, ensure that you have authenticated yourself, then reference an account, then access that account’s mentions. See the Get started documentation for more details.
`authenticate()`	Authenticate yourself with BrandsEye
`account()`	Access account information
`mentions()`	Fetch mentions from an account
`update_mentions()`	Update data stored on a mention
`count_mentions()`	Count mentions
`dashboards()`	List the dashboards in an account
Authenticating Authentication is the first thing that you should do when using the library. It allows you to identify yourself with our API, and lets you know what accounts and brands you have access to.
`authenticate()`	Authenticate yourself with BrandsEye
`whoami()`	Returns your current authentication credentials.
`am_i_brandseye()`	Are you authorised as a BrandsEye staff member?
Accounts These functions allow you to determine what accounts you have access to, and to query information about them, such as the brands that you are tracking, and the tags and topics in each account.
`account()`	Access account information
`is_account()`	See if an object is a account object
`account_api_version()`	Get the version of the API the account uses
`account_client_code()`	Get an account's client code
`account_code()`	Get an account's code
`account_list()`	List all accounts available to you
`account_manager()`	See your account manager
`account_name()`	Get an account's name
`account_timezone()`	Get an account's timezone
`account_type()`	Get an account's type
`brands()`	Fetch brand information
`root_brands()`	Find root brands in an account
`phrases()`	Fetch phrases for an accounts and mentions
`tags()`	Fetch tags for accounts and mention data
`topics()`	Fetch topics for an account or tibble of mentions
`topic_trees()`	List topic trees for an account
`create_tags()`	Add tags to an account
`with_tag_parents()`	Determine the parent of tags given a particular tree
`users()`	Get users for an account
`logs()`	Read account logs
`rules()`	Read account rules
`profiles()`	Read online profiles for an account
Accessing mentions Mentions make up the raw data that we store for you. Sentiment information and topic information are stored against individual mentions. These functions allow you to query for particular kinds of mentions using a filter language, to count mentions matching particular parameters, and to update the information stored on mentions. Important functions include mentions() to pull mentions in your account, and count_mentions(), to count mentions matching a particular filter.
`mentions()`	Fetch mentions from an account
`tags()`	Fetch tags for accounts and mention data
`topics()`	Fetch topics for an account or tibble of mentions
`brands()`	Fetch brand information
`phrases()`	Fetch phrases for an accounts and mentions
`count_mentions()`	Count mentions
`update_mentions()`	Update data stored on a mention
A query language: filtering and grouping your mentions Often, when counting or fetching mentions, you may need to specify a filter, or the brands in the filter, and so on. The query language lets you easily define these things, as well as avoid specify brands in each and every filter. The Get started guide discusses this in more detail.
`query()`	Create a query for mentions or counts
`with_account()`	Add accounts to a query.
`filter_mentions()`	Filter for only specific mentions
`group_mentions_by()`	Group mentions by shared criteria
`compare_mentions()` `compare_mentions_raw()`	Compare mentions using sub-filters when counting them
`with_mention_fields()`	Select extra data when fetching or counting mentions
`with_mention_order()`	Order results from fetching or counting mentions
`is_query()`	See if an object is a BrandsEyeR query
`to_query()`	Create a query object from another object
`get_query_brands()`	See brands in a query
`get_query_accounts()`	See the accounts in a query.
Working with account logs Most actions on user accounts are logged. brandseyer2 provides various functions to read and filter account logs, starting with the all encompassing logs() function, which returns all the logs in a time period for the account.
`logs()`	Read account logs
`logs_retrosent()`	Finding retrosends for accounts
Account dashboards In Analyse, BrandsEye’s analysis tool, people can set up dashboards to query our data. We have various functions that help you to read data from the dashboards, their various sub-sections, an the metrics that they contain.
`dashboards()`	List the dashboards in an account
`sections()`	Give section information for a dashboard
`metrics()`	See metrics in a dashboard

Reference

Quick start

Authenticating

Accounts

Accessing mentions

A query language: filtering and grouping your mentions

Working with account logs

Account dashboards