get_tb: Get and collect responses from the TeachBoost API.

Description Usage Arguments Value Examples

View source: R/get_tb.R

Description

A wrapper around teachboost_api, which will return as many response objects as needed (given any constraints passed on to teachboost_api)

Usage

1
get_tb(endpoint, key, ...)

Arguments

endpoint

the TeachBoost API endpoint to sent a GET request to.

key

your organizations unique TeachBoost API key. If one is not supplied the function will look in the R enivronment for a TB_KEY key and retriev it's value. You can place your key in an .Renviron file.

...

parameters passed on to teachboost_api

Value

a list of teachboost response objects

Examples

1
2
3
4
5
6
## Not run: 
x <- get_teachboost("users")

x <- get_teachboost("forms", limit = 1200)

## End(Not run)

kippchicago/teachboostr documentation built on May 20, 2019, 10:23 a.m.