advertising_reports: Request SEMRush Advertising Reports

In ericvc/semRush: semRush: an R package for creating and customizing requests for data reports through the SEMRush SEO database API

Description

This function creates a request to the SEMRush SEO database for users with a subscription and sufficient API units.

Usage

advertising_reports(
  type,
  key,
  domain,
  advertiser_domain,
  publisher_domain,
  display_limit = 5,
  display_offset,
  device_type,
  export_columns,
  return_url = FALSE,
  timestamp = TRUE
)

Arguments

type	string. The report type to be generated. Available report types are "publisher_text_ads", "publisher_advertisers", "advertiser_publishers", "advertiser_text_ads", "advertiser_landings", "advertiser_publisher_text_ads", "advertiser_rank", or "publisher_rank".
key	string. An identification key assigned to a user after subscribing to SEMrush. The key is available on the Profile page.
domain	string. A unique name of a website you would like to investigate (example.com).
advertiser_domain	string. A unique name of a website you would like to investigate (example.com). Used for 'advertiser_publisher_text_ads' report only.
publisher_domain	string. A unique name of a website you would like to investigate (example.com). Used for 'advertiser_publisher_text_ads' report only.
display_limit	integer. The number of results returned to a request. If this parameter is set to 0, up to 10,000 lines will be returned. Default is 5 lines.
display_offset	integer. This parameter allows you to skip a specified number of results before sending a report. Please keep in mind that if you use the option display_offset, display_limit, the value should be increased by value display_offset.
device_type	string. This parameter shows the type of device by which statistics have been collected-a PC, tablet, or smartphone. Only used for some report types. Options: "all", "desktop", "smartphone_apple", "smartphone_android", "tablet_apple", or "tablet_android".
export_columns	vector. A vector of character strings specifying the variables to be included in the report, which vary according to the report type (see 'type' argument). If this parameter is not specified, default columns will be sent.
return_url	logical. If TRUE, prints the request URL used to generate the report. Default value is FALSE.
timestmap	logical. If TRUE (default), converts

Value

A data table (tibble) with columns for each requested variable.

Examples

## Enter your SEMRush account API key
## Not run: 
key <- "" #enter your SEMRush account API key.

##Get 'backlinks_overview' report
advertising_reports(
type = "advertiser_landings",
domain = "cran.r-project.org",
key = key,
device_type = "all",
return_url = FALSE
)


## End(Not run)

ericvc/semRush documentation built on Aug. 7, 2020, 12:54 p.m.