This function reads the available logging messages from REDCap as a tibble::tibble().

redcap_log_read(
  redcap_uri,
  token,
  log_begin_date = Sys.Date() - 7L,
  log_end_date = Sys.Date(),
  record = NULL,
  user = NULL,
  http_response_encoding = "UTF-8",
  locale = readr::default_locale(),
  verbose = TRUE,
  config_options = NULL,
  handle_httr = NULL
)

Arguments

redcap_uri

The uri/url of the REDCap server typically formatted as "https://server.org/apps/redcap/api/". Required.

token

The user-specific string that serves as the password for a project. Required.

log_begin_date

Return the events occurring after midnight of this date. Defaults to the past week; this default mimics the behavior in the browser and also reduces the strain on your server.

log_end_date

Return the events occurring before 24:00 of this date. Defaults to today.

record

Return the events belonging only to specific record (referring to an existing record name). Defaults to NULL which returns logging activity related to all records. If a record value passed, it must be a single value.

user

Return the events belonging only to specific user (referring to an existing username). Defaults to NULL which returns logging activity related to all users. If a user value passed, it must be a single value.

http_response_encoding

The encoding value passed to httr::content(). Defaults to 'UTF-8'.

locale

a readr::locale() object to specify preferences like number, date, and time formats. This object is passed to readr::read_csv(). Defaults to readr::default_locale().

verbose

A boolean value indicating if messages should be printed to the R console during the operation. The verbose output might contain sensitive information (e.g. PHI), so turn this off if the output might be visible somewhere public. Optional.

config_options

A list of options passed to httr::POST(). See details at httr::httr_options(). Optional.

handle_httr

The value passed to the handle parameter of httr::POST(). This is useful for only unconventional authentication approaches. It should be NULL for most institutions. Optional.

Value

Currently, a list is returned with the following elements:

  • data: An R tibble::tibble() of all data access groups of the project.

  • success: A boolean value indicating if the operation was apparently successful.

  • status_codes: A collection of http status codes, separated by semicolons. There is one code for each batch attempted.

  • outcome_messages: A collection of human readable strings indicating the operations' semicolons. There is one code for each batch attempted. In an unsuccessful operation, it should contain diagnostic information.

  • elapsed_seconds: The duration of the function.

References

The official documentation can be found on the 'API Help Page' and 'API Examples' pages on the REDCap wiki (i.e., https://community.projectredcap.org/articles/456/api-documentation.html and https://community.projectredcap.org/articles/462/api-examples.html). If you do not have an account for the wiki, please ask your campus REDCap administrator to send you the static material.

Author

Jonathan M. Mang, Will Beasley

Examples

# \dontrun{
uri          <- "https://bbmc.ouhsc.edu/redcap/api/"
token        <- "9A81268476645C4E5F03428B8AC3AA7B"

ds_last_week <- REDCapR::redcap_log_read(redcap_uri=uri, token=token)$data
#> 7,566 rows were read from REDCap in 0.4 seconds.  The http status code was 200.
head(ds_last_week)
#> # A tibble: 6 × 4
#>   timestamp           username        action            details                 
#>   <dttm>              <chr>           <chr>             <chr>                   
#> 1 2023-01-25 14:20:00 unittestphifree Manage/Design     Export instruments (API)
#> 2 2023-01-25 14:20:00 unittestphifree Manage/Design     Export DAGs (API)       
#> 3 2023-01-25 14:20:00 unittestphifree Data export (API) export_format: CSV, raw…
#> 4 2023-01-25 14:20:00 unittestphifree Data export (API) export_format: CSV, raw…
#> 5 2023-01-25 14:20:00 unittestphifree Data export (API) export_format: CSV, raw…
#> 6 2023-01-25 14:20:00 unittestphifree Data export (API) export_format: CSV, raw…

ds_one_day <-
  REDCapR::redcap_log_read(
    redcap_uri     = uri,
    token          = token,
    log_begin_date = as.Date("2020-08-10"),
    log_end_date   = as.Date("2020-08-10")
  )$data
#> 96 rows were read from REDCap in 0.2 seconds.  The http status code was 200.
head(ds_one_day)
#> # A tibble: 6 × 4
#>   timestamp           username        action            details                 
#>   <dttm>              <chr>           <chr>             <chr>                   
#> 1 2020-08-10 19:25:00 unittestphifree Data export (API) export_format: CSV, raw…
#> 2 2020-08-10 19:25:00 unittestphifree Data export (API) export_format: CSV, raw…
#> 3 2020-08-10 19:25:00 unittestphifree Data export (API) export_format: CSV, raw…
#> 4 2020-08-10 19:25:00 unittestphifree Data export (API) export_format: CSV, raw…
#> 5 2020-08-10 19:25:00 unittestphifree Data export (API) export_format: CSV, raw…
#> 6 2020-08-10 19:25:00 unittestphifree Manage/Design     Download data dictionar…

ds_one_day_single_record_single_user <-
  REDCapR::redcap_log_read(
    redcap_uri     = uri,
    token          = token,
    log_begin_date = as.Date("2021-07-11"),
    log_end_date   = as.Date("2021-07-11"),
    record         = as.character(3),
    user           = "unittestphifree"
  )$data
#> 12 rows were read from REDCap in 0.2 seconds.  The http status code was 200.
head(ds_one_day_single_record_single_user)
#> # A tibble: 6 × 4
#>   timestamp           username        action        details            
#>   <dttm>              <chr>           <chr>         <chr>              
#> 1 2021-07-11 23:08:00 unittestphifree Manage/Design Download file (API)
#> 2 2021-07-11 23:08:00 unittestphifree Manage/Design Download file (API)
#> 3 2021-07-11 23:04:00 unittestphifree Manage/Design Download file (API)
#> 4 2021-07-11 23:04:00 unittestphifree Manage/Design Download file (API)
#> 5 2021-07-11 22:56:00 unittestphifree Manage/Design Download file (API)
#> 6 2021-07-11 22:56:00 unittestphifree Manage/Design Download file (API)
# }