qb_run {qbr} | R Documentation |
Run a Quickbase report
Description
Run a report and get its data.
Usage
qb_run(
subdomain,
token,
table_id,
report_id,
agent = NULL,
skip = 0,
top = 0,
type_suffix = FALSE,
paginate = TRUE
)
Arguments
subdomain |
Character vector with one element. Found at the beginning of the Quickbase URL. Realm specific. |
token |
Character vector with one element. Created in 'My Preferences' under 'Manage user tokens' link. |
table_id |
Character vector with one element. Found in the URL of a Quickbase table between /db/ and ? |
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 |
Value
A tibble.
References
Examples
## Not run:
# Get all data in a report
my_tibble <- qb_run(subdomain = "abc",
token = keyring::key_get("qb_example"),
table_id = "bn9d8iesz",
report_id = "1")
# Get rows 3 to 6 from a report
my_tibble <- qb_run(subdomain = "abc.quickbase.com",
token = keyring::key_get("qb_example"),
table_id = "bn9d8iesz",
report_id = "1",
skip = 2,
top = 3)
## End(Not run)