Description
Interface to the 'Briq' API.
Description
An interface to the 'Briq' API <https://briq.github.io>. 'Briq' is a tool that aims to promote employee engagement by helping employees recognize and reward each other. Employees can praise and thank one another (for achieving a company goal, for example) by giving virtual credits (known as 'briqs' or 'bqs') that can be redeemed for various rewards. The 'Briq' API lets you create, read, update and delete users, user groups, transactions and messages. This package provides functions that simplify getting the users, user groups and transactions of your organization into R.
README.md
briqr
Overview
briqr provides access to the Briq API using R
Installation
devtools::install_github("davidrubinger/briqr")
Authentication
Get a Briq API token by creating a new custom application in the Briq admin section.
briqr functions will read the API token from environment variable briq_api_token, which should be included in a .Renviron file in your home directory like so: briq_api_token = your_briq_api_token
briqr functions will read your organization name from environment variable organization_name, which should be included in .Renviron like so: organization_name = your_organization_name
Usage
You can get data frames of all the users (bq_users()), user groups (bq_groups()) and transactions (bq_transactions()) of your organization.
Example
Return a tibble of all Briq users within your organization:
library(briqr)
bq_users()