get_archived_data: Get archived (flow/run) data

In lilyclements/Rapidreadr: Read Data From a RapidPro API

Get archived (flow/run) data

Description

Download the archived run data from RapidPro.

Usage

get_archived_data(
  rapidpro_site = get_rapidpro_site(),
  token = get_rapidpro_key(),
  period = "monthly",
  flatten = FALSE,
  date_from = NULL,
  date_to = NULL,
  archive_type = c("run", "messages"),
  format_date = "%Y-%m-%d",
  tzone_date = "UTC"
)

Arguments

rapidpro_site	A string containing the rapidpro website to call the data from. See set_rapidpro_site() to amend the website.
token	A string containing the token to call the data. See set_rapidpro_key() to amend the token.
period	Default "monthly". A character string giving the period of time. One of "monthly", "daily", or "none".
flatten	Default FALSE. A boolean denoting whether the data should be flattened into a two-dimensional tabular structure.
date_from	character string giving the date to filter the data from.
date_to	character string giving the date to filter the data to.
archive_type	character string denoting whether to call "runs" or "messages" data.
format_date	from ⁠as.POSIX*⁠ function: character string giving a date-time format as used by strptime.
tzone_date	from ⁠as.POSIX*⁠ function: time zone specification to be used for the conversion, if one is required. System-specific (see time zones), but "" is the current time zone, and "GMT" is UTC (Universal Time, Coordinated). Invalid values are most commonly treated as UTC, on some platforms with a warning.

Value

Archived data

lilyclements/Rapidreadr documentation built on April 17, 2025, 6:10 p.m.