R/url_reports.R

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

#' Request SEMRush URL Reports
#'
#' @description This function creates a request to the SEMRush SEO database for users with a subscription and sufficient API units.
#' See the SEMRush API website \href{https://www.semrush.com/api-analytics/}{(https://www.semrush.com/api-analytics/)} for additional information, including a list of codes for the regional databases and export variables.
#' @param type \emph{string}. REQUIRED. The report type to be generated. Available report types are 'url_organic' or 'url_adwords'.
#' @param key \emph{string}. REQUIRED. An identification key assigned to a user after subscribing to SEMrush. The key is available on the Profile page.
#' @param url	\emph{string}. REQUIRED. The URL of a landing page you would like to investigate (example: https://cran.r-project.org/).
#' @param database 	\emph{string}. REQUIRED. A regional database. If this parameter is not specified (i.e., ""), your request will be sent to all regional databases.
#' @param display_limit \emph{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.
#' @param display_offset \emph{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.
#' @param display_date \emph{string}. Date in format "YYYYMM15". A date on which a report will be shown. You can roll back to the past or choose an actual date.
#' @param export_columns \emph{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.
#' @param return_url \emph{logical}. If TRUE, prints the request URL used to generate the report. Default value is FALSE.
#'
#' @importFrom assertthat assert_that
#' @importFrom assertthat noNA
#' @importFrom assertthat is.string
#' @importFrom assertthat not_empty
#' @importFrom methods hasArg
#' @importFrom tibble as_tibble
#' @import stringr
#' @importFrom rlang .data
#'
#' @return A data table (tibble) with columns for each requested variable.
#' @export
#'
#'@examples
#'\dontrun{
#'#Enter your SEMRush account API key.
#'#'key <- ""
#'
#'## Get 'url_organic' report
#'urlToInvestigate <- "https://cran.r-project.org/"
#'#request report
#'report <- url_reports(
#'     type = "url_organic",
#'     key = key,
#'     url = urlToInvestigate,
#'     database = "us",
#'     display_limit = 5,
#'     export_columns = c("Ph", "Po", "Pp", "Nq", "Cp")
#')
#'
#'print(report)
#'# A tibble: 5 x 5
#'  Keyword                    Position Previous.Position Search.Volume   CPC
#'  <chr>                         <int>             <int>         <int> <dbl>
#'1 cran                              1                 1          8100  1.42
#'2 r cran                            1                 1          5400  0   
#'3 r cran download                   1                 1           590  0   
#'4 cran r project org windows        1                 1           590  0   
#'5 cran r project                    1                 1           480  0
#'} 
url_reports <- function(type, key, url, database, #required arguments
                            display_limit=5, display_offset,
                            display_date, export_columns,
                            return_url = FALSE
)
{

  ## Set defaults
  display_limit <- display_limit

  ## Check that universal required arguements are present and valid
  assert_that(noNA(type), not_empty(type), is.string(type),
              noNA(key), not_empty(key), is.string(key)
              )

  ## Check that requested report is a valid choice.
  #A list of the available types of reports that can be generated.
  report_types = c("url_adwords","url_organic")
  assert_that(length(type)==1, is.string(type))
  if(!type %in% report_types){
    stop("Invalid report type requested.")
  }

  ## Check that API key format is valid
  assert_that(length(key)==1, is.string(key))

  ## Match report types with appropriate export columns
  if(type == "url_organic"){

    ## Check requested data to ensure it matches selected report type
    #List of valid export columns for this report type
    export_columns_default = c("Ph","Po","Pp","Nq","Cp","Co","Kd","Tr","Tg","Tc","Nr","Td","Fp","Fk","Ts")
    if(hasArg(export_columns)){
      if(any(!export_columns %in% export_columns_default)){
        "Invalid export columns for requested report type."
      }
    }

  } #end report type: url_organic

  if(type == "url_adwords"){

    ## Check requested data to ensure it matches selected report type
    #List of valid export columns for this report type
    export_columns_default = c("Ph","Po","Nq","Cp","Co","Tg","Tr","Tc","Nr","Td","Tt","Ds","Ts")
    if(hasArg(export_columns)){
      if(any(!export_columns %in% export_columns_default)){
        "Invalid export columns for requested report type."
      }
    }

  } #end report type: url_adwords

  ## Create URL request (base)
  request_url <- paste0("https://api.semrush.com/?key=",key,
                        "&type=",type,
                        "&database=",database,
                        "&url=",url)

  ## Append optional parameters to the URL request
  if(hasArg(display_limit)){
    assert_that(display_limit == as.integer(display_limit))
    request_url <- paste0(request_url, "&display_limit=", display_limit)
  }
  if(hasArg(display_offset)){
    assert_that(display_offset == as.integer(display_offset))
    request_url <- paste0(request_url, "&display_offset=", display_offset)
  }
  if(hasArg(display_date)){
    assert_that(is.string(display_date), grepl("^20[0-2][0-9][0|1][0-9]15", x=display_date))
    request_url <- paste0(request_url, "&display_date=", display_date)
  }
  if(hasArg(export_columns)){
    assert_that(noNA(export_columns), all(sapply(export_columns, is.string)))
    if(any(!export_columns %in% export_columns_default)){
      stop("Invalid export columns for requested report type.")
    }
    if(length(export_columns)>1){
      export_columns <- paste0(export_columns, collapse = ",")
    }
    request_url <- paste0(request_url, "&export_columns=", export_columns)
  }

  if(return_url){
    print(paste0("Request URL: ",request_url))
  }
  response <- httr::GET(request_url)
  #get content from return
  cont <- httr::content(response, as="text")

  if(response$status_code == 200){

    if(stringr::str_detect(cont, "ERROR")){
      stop(sprintf("Something went wrong. Check input arguments. (%s)",cont))
    }

    d <- cont %>%
      textConnection() %>%
      utils::read.table(.data, sep=";", header=TRUE, stringsAsFactors = FALSE) %>%
      tibble::as_tibble

    return(d)


  } else{

    warning(sprintf(
      "Status code returned was not 200 (status: %s)",
      as.character(response$status_code)
    ))

  }

}