Documentation

Instructions and usage

The Parameter Selector

Made up of four 'facets', or ways to filter down the data generated in the reports, the parameter selector is your tool for report customization. For each category you can choose a date range and to include or exclude certain users, pages, page owned by specific users, sections, or page types from the generated reports. At least one filter is required to run the reporting tool. The larger your date range and the more broad your filters are, the longer the query will take.

If you repeatedly use the same filters, you can save your selections by name using the 'Save filters' button in the top left corner. Each save filter will appear when you come back to the page, and will be added with a double click. Additionally, you can have multiple instances of the TF Stats card. Each will retain its own set of saved filters. This is a great way for power users or team leaders to create their own dashboards with filters specific to their reporting needs.
 
paramselector.png
The parameter selector without the page owner facet included.
A filter, 'Vancouver office' has been saved.

The User Report & Page Report

The reports can be sorted from lowest-highest and vice versa by clicking on the table headers. You can export your data to excel with an optional custom name using the export button for each. They harness google tables to make for easy sorting.

For the user report, the table returns the following for actions performed within the specified time window:
userreport.png
 
1.  Name: the name of each user
2. Groups:  the groups the user has joined in the time range selected in the parameter selector
3. Views: the views that user has made on the specified pages
4. Unique views: the views that user has made on the specified pages outside of a 30 minute session window
5. Creates: If the user has created any of the specified pages, they will be counted here
5. Edits:  If the user has edited any of the specified pages, they will be counted here
6. Downloads: If the user has downloaded any files off of the specified pages, they will be counted here
7. Unique downloads: The downloads the user has made on the specified pages outside of a 30 minute session window
8. Searches: How many searches the user has made. This does not include searches that were not executed by hitting the 'search' button (by starting to type in the name of the page, and going directly to that page is not track-able.)
9. Likes: How many pages the user liked
9. Follows: How many pages the user followed
9. Comments: How many comments the user made
9. Bookmarks: How many pages the user bookmarked


For the page report, the table returns the following page information and actions performed on the page within the specified time window:
 
page%20report.png
1. ContentId: the page content id
2. Title: the page title
3. Owner: the page owner
4. Tree path: the parent pages of the page to indicate nesting and page hierarchy
5. Parent title: the direct parent page title
6. Page type: the type of page 
7. Views: how many views the page has
8. Unique views: the views the page had outside of a 30 minute session window
9. Creates: If the page was created within the specified time window (1 for yes; 0 for no)
10. Edits: If the page was edited, and how many times
11. Downloads: If any files were downloaded from the page, and how many times
12. Unique downloads: How many times a file was downloaded from a page outside of a 30 minute session window
13. Likes: How many likes the page has
14. Follows: How many follows the page has
15. Comments: How many comments the page has
16. Bookmarks: How many bookmarks the page has