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
)The uri/url of the REDCap server typically formatted as "https://server.org/apps/redcap/api/". Required.
The user-specific string that serves as the password for a project. Required.
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.
Return the events occurring before 24:00 of this date. Defaults to today.
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.
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.
The encoding value passed to
httr::content(). Defaults to 'UTF-8'.
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().
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.
A list of options passed to httr::POST().
See details at httr::httr_options(). Optional.
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.
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.
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.
# \dontrun{
uri <- "https://bbmc.ouhsc.edu/redcap/api/"
token <- "9A81268476645C4E5F03428B8AC3AA7B"
ds_last_week <- REDCapR::redcap_log_read(redcap_uri=uri, token=token)$data
#> 5,105 rows were read from REDCap in 0.2 seconds. The http status code was 200.
head(ds_last_week)
#> # A tibble: 6 × 5
#> timestamp username action details record
#> <dttm> <chr> <chr> <chr> <lgl>
#> 1 2024-01-22 11:10:00 unittestphifree Manage/Design Export instrumen… NA
#> 2 2024-01-22 11:10:00 unittestphifree Manage/Design Export DAGs (API) NA
#> 3 2024-01-22 11:10:00 unittestphifree Manage/Design Download data di… NA
#> 4 2024-01-22 11:10:00 unittestphifree Manage/Design Export project i… NA
#> 5 2024-01-22 10:59:00 unittestphifree Manage/Design Download data di… NA
#> 6 2024-01-22 10:59:00 unittestphifree Data export (API) export_format: C… NA
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.1 seconds. The http status code was 200.
head(ds_one_day)
#> # A tibble: 6 × 5
#> timestamp username action details record
#> <dttm> <chr> <chr> <chr> <lgl>
#> 1 2020-08-10 19:25:00 unittestphifree Data export (API) export_format: C… NA
#> 2 2020-08-10 19:25:00 unittestphifree Data export (API) export_format: C… NA
#> 3 2020-08-10 19:25:00 unittestphifree Data export (API) export_format: C… NA
#> 4 2020-08-10 19:25:00 unittestphifree Data export (API) export_format: C… NA
#> 5 2020-08-10 19:25:00 unittestphifree Data export (API) export_format: C… NA
#> 6 2020-08-10 19:25:00 unittestphifree Manage/Design Download data di… NA
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.1 seconds. The http status code was 200.
head(ds_one_day_single_record_single_user)
#> # A tibble: 6 × 5
#> timestamp username action details record
#> <dttm> <chr> <chr> <chr> <lgl>
#> 1 2021-07-11 23:08:00 unittestphifree Manage/Design Download file (API) NA
#> 2 2021-07-11 23:08:00 unittestphifree Manage/Design Download file (API) NA
#> 3 2021-07-11 23:04:00 unittestphifree Manage/Design Download file (API) NA
#> 4 2021-07-11 23:04:00 unittestphifree Manage/Design Download file (API) NA
#> 5 2021-07-11 22:56:00 unittestphifree Manage/Design Download file (API) NA
#> 6 2021-07-11 22:56:00 unittestphifree Manage/Design Download file (API) NA
# }