Skip to content

Commit 85bc2ac

Browse files
authored
chore: release Content Usage Metrics app (#92)
* format with air * fix onRestore & comment * Remove dev data shims * Improve action link styling * move to “content-usage-metrics” directory * update readme * update manifest with new dependency * reduce cache age to 1 hour * update manifest * First draft of user guide readme * update manifest * Update extensions/content-usage-metrics/manifest.json * Respond to feedback
1 parent c73ded5 commit 85bc2ac

File tree

13 files changed

+326
-176
lines changed

13 files changed

+326
-176
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Content Usage Metrics
2+
3+
A Shiny app that helps you understand usage patterns across your work on Connect. Browse an overview of usage across everything you've published, and dive into detailed breakdowns of data for an individual deployment, down to the level of individual visits.
4+
5+
## Setup
6+
7+
After deploying this app, you'll need to add a Visitor API Key integration.
8+
9+
In the app's control panel on the right of the screen, in the Access tab, click **"Add integration"**, then select a **Visitor API Key** integration.
10+
11+
If you don't see one in the list, an administrator must enable this feature on your Connect server.
12+
See the [Admin Guide](https://docs.posit.co/connect/admin/integrations/oauth-integrations/connect/) for setup instructions.
13+
14+
## Viewing usage data
15+
16+
The Content Usage Metrics app shows you usage data for your content on the Connect server where it's published. There are two main views: a table that shows you usage overview across pieces of content, and a detail view that breaks down usage for a selected piece of content by visitor and over time. The app's sidebar contains controls to filter the data and adjust how it is displayed. Some controls affect data across the entire app, and some are only available for the table or the detail views.
17+
18+
### Global controls
19+
20+
- Date Range: Adjust the date range for displayed data. You can select a preset window or custom date range.
21+
- Visit Merge Window (sec): Merges together visits from the same user that occurred rapidly back to back. For example, if the Visit Merge Window control is set to "30", any given user's visits to a piece of content will only count at most once every 30 seconds.
22+
23+
### Usage Overview Table
24+
25+
The overview table shows a table row for each piece of content. You can sort or search the table, and adjust the set of data shown using controls in the sidebar:
26+
27+
- Included Content: Administrators can view all content on the server. Both Administrators and Publishers can also view content they own plus content on which they are collaborators, or just content they own.
28+
- Filter by Content Type: Select one or more content types to show only those types in the table.
29+
- Show GUID: Show or hide the content GUID in the table.
30+
- Export Usage Table: Download the data displayed in the usage table. The data downloaded is specifically the data displayed, *after* filtering by date range, applying the visit merge window, and filtering for ownership and content type.
31+
- Export Raw Visit Data: Export the raw data downloaded from Connect, with a field for `user_guid`, `timestamp`, and `content_guid`.
32+
33+
### Content Detail View
34+
35+
Click on a piece of content in the table to view detailed usage information.
36+
37+
This view include two plots: a histogram aggregating visits by day, and a plot showing each user's visits on a timeline. It also includes two tables: one showing the total visits for each user in the selected date range, and a list of all visits.
38+
39+
Sidebar controls include:
40+
41+
- Filter Visitors: Select the visitors whose data you wish to view. You can also toggle selection for a given user by clicking their name in the Top Visitors table.
42+
- Email Selected Users: Open a `mailto` link populated with the email addresses of the users whose data you're viewing.
43+
44+
### Other controls
45+
46+
- Clear Cache: The app caches data from Connect's API for an hour, to speed up repeated views. Use this button if you need to manually refresh the displayed data.

0 commit comments

Comments
 (0)