qbr (version 1.3.0)

run_report: Run a report

Description

Run a report and get its data.

Usage

run_report(
  subdomain,
  auth,
  table_id,
  report_id,
  agent = NULL,
  skip = 0,
  top = 0,
  type_suffix = FALSE,
  paginate = TRUE
)

Value

A tibble.

Arguments

subdomain

Character vector with one element. Found at the beginning of the Quickbase URL. Realm specific.

auth

Character vector with one element. The Quickbase authentication scheme you are using to authenticate the request (e.g., user token).

table_id

Character vector with one element. Found in the URL of a Quickbase table.

report_id

Character vector with one element. Found in the 'Reports & Charts' page in Quickbase and in the report URL.

agent

Optional. Character vector with one element. Describes user/agent making API call.

skip

Optional. Integer. The number of rows to skip from the top of a record set.

top

Optional. Integer. The limit on the number of records to pull starting at the top of a record set.

type_suffix

Optional. Logical. Set TRUE to append each field label with its Quickbase data type.

paginate

Optional. Logical. Set TRUE to recursively call the API until all report pages are collected.

References

Quickbase API documentation

Examples

if (FALSE) {

   # Get all data in a report
   my_tibble <- run_report(subdomain = "abc",
       auth = keyring::key_get("qb_example"),
       table_id = "bn9d8iesz",
       report_id = "1")

   # Get rows 3 to 6 from a report
   my_tibble <- run_report(subdomain = "abc.quickbase.com",
       auth = keyring::key_get("qb_example"),
       table_id = "bn9d8iesz",
       report_id = "1",
       skip = 2,
       top = 3)
}