mentions: Fetch mentions from an account

In brandseye/brandseyer2: Provides access to data stored in a BrandsEye account

Description

This provides access to an account's mentions.

Usage

mentions(x, filter, select, ..., .envir)

## S3 method for class 'brandseyer2.account.v4'
mentions(
  x,
  filter,
  select = NULL,
  ...,
  .envir = parent.frame(),
  orderBy = NULL,
  fetchGraph = FALSE
)

Arguments

x	An account object
filter	A query to match mentions against. Always required. See the filter vignette for details.
select	A character vector of the mention fields to be returned.
...	Further arguments passed to or from other methods.
.envir	An optional environment for when substituting values in to select.
orderBy	Fields to order the returned data by. Defaults to published
fetchGraph	Fetch other mentions that are part of the same conversation as this one.

Value

A tibble of mentions. Returns an empty tibble if there are no mentions.

Methods (by class)

• brandseyer2.account.v4: Read mentions from an account. Returns a tibble of mention data.

Availability of content

Tweets, by default, will be given with no content, only URIs and IDs. This is per our agreement with twitter. Twitter does provide an API for obtaining tweet content using tweet IDs.

If you fetch mentions and choose not to select the site field (selected by default), all mentions may contain no data.

Note

We cannot read data from older, V3 accounts / APIs.

See Also

tags() to fetch tag information from mentions.

topics() to fetch topic information from mentions.

brands() to fetch brand information from mentions.

phrases() to fetch phrase information from mentions.

Examples

# Reading data from a single account
account("TEST01AA") %>%
  mentions(filter = "published inthelast week and brand isorchildof 1") # Must always have a filter

brandseye/brandseyer2 documentation built on Sept. 5, 2021, 2:15 p.m.