R/workflow.R

In brandwatchR: 'Brandwatch' API to R

#' Get a list of workflows for the specified query and project
#'
#' Refer to https://developers.brandwatch.com/docs/retrieving-workflow for more information.
#'
#' @param token
#' The authentication token, acquired using bwr_auth()
#' @param project_id
#' The project id in which the specified workflow is contained. Obtain a list of project IDs using bwr_get_projects().
#' @return
#' Returns a list containing all results
#' @export
#'
#' @examples
#' \dontrun{my_project <- bwr_get_projects()$id[1]
#' my_workflow <- bwr_wf_get(project_id = my_project)}
#'
bwr_wf_get <- function(project_id = NULL, token = Sys.getenv("BW_TOKEN")) {

    # Check for valid arguments -----------------------------------------------
    if (length(token) != 1 || class(token) != "character")
        stop("Token object does not appear to be a character vector of length one. Please re-run bwr_auth() to obtain a token")
    if (is.null(project_id) || length(project_id) != 1 || !class(project_id) %in% c("character", "numeric", "integer"))
        stop("project_id must be a character or numeric vector of length one")

    url <- paste0("https://api.brandwatch.com/projects/", project_id, "/workflow")
    r <- httr::GET(url, query = list(access_token = token))
    httr::stop_for_status(r)

    # Parse the results and return
    con <- httr::content(r, "text")
    json <- jsonlite::fromJSON(con)
    json
}