Skip to content

Tag Usage on RStudio Connect#

Answer the Question:

  • How many tags are in use on the server and which content items are tagged?

Step 1 - Get the report code#

Step 2 - Run & Customize the report#

This R Markdown report uses the /v1/tags and /v1/tags/{id}/content API endpoints available in RStudio Connect 1.8.6 and later. Visit the RStudio Connect API Reference documentation for more information.

Requirements: Administrator API Key

Create an .Renviron file to store your API key and RStudio Connect server URL.

Your RStudio Connect server URL is the same URL you use to access the RStudio Connect dashboard, minus the connect path. If you access the dashboard at https://rsc.company.com/connect/, the server URL is https://rsc.company.com/.

# ~/.Renviron
# The CONNECT_SERVER URL must have a trailing slash.
CONNECT_SERVER="https://rsc.company.com/"
CONNECT_API_KEY="mysupersecretapikey"

Restart your R session to pick up on the new environment variables.

Step 3 - Publish the report to RStudio Connect#

If you are push-button publishing from the RStudio IDE, we recommend the selection "Publish document with source code" so that the report can be re-executed on a schedule.

Source code documents that use Sys.getenv() to load the server URL and API Key will fail to complete the knit process on first deployment.

To fix the failed knit process:

  1. Navigate to your incomplete content item on RStudio Connect.
  2. Open the Vars content management pane.
  3. Add your CONNECT_API_KEY and CONNECT_SERVER environment variables.
  4. Re-execute the content code by clicking on the "Refresh Report" button (shown below).

Step 4 (optional) - Set the report to update on a schedule#

Automate a data refresh of your report by setting it up to run on a schedule. Open the Schedule content management pane to get started.

Read more about Scheduling in the RStudio Connect User Guide.