You've probably used your usage report to analyze your site usage. Now you can download the actual HelpRequest logs for all that usage and analyze it even further! This article outlines how to download MindTouch HelpRequests (user event data) logs and contains a glossary of log entries.
Why should I download HelpRequest logs?
Understanding the trends on your site can be a fantastic way to analyze and understand important data points. Download HelpRequest logs to answer some of the following questions:
- Am I driving new users to my site?
- Am I reducing the need to search, thereby increasing page views and creating more knowledgeable users?
- How often do users search from within contextual help?
How do I get my data?
Download HelpRequest logs via the usage report, which is only accessible to admin users. Perform the following steps to download the log:
- Select the month for which you want to pull a log.
- Click Download log.
Logs are updated at the end of every day and are delivered in CSV (comma-separated value) format. The logs contain information on every HelpRequest that occurs on your site. You may also download the log for the current month up to the previous day.
How do I unzip my downloaded file?
Look for a downloaded
.gzip file in your default downloads folder on your computer or default downloads folder in your browser. Unzip as follows:
If you're using a Mac:
- Navigate to your download folder.
- Double-click the file.
- Your operating system will automatically convert to a zip format.
- Unzip the file.
If you're using Windows:
- Navigate to your download folder.
- Use a program like WinZip.
- Either unzip the file directly or convert it from .gzip to .zip and then unzip.
I have the logs, what do they mean?
The audit logs contain requests that MindTouch considers HelpRequests. HelpRequests are generally classified as page views, searches and PDF generations. The logs are meant to give insight into how your users are using your site and where these users are coming from. The CSV document contains several columns:
- ► event_id
- Unique identifier for this particular HelpRequest. Identifies a particular HelpRequest. Can be used to reference a particular HelpRequest with MindTouch.
- ► event_datetime
- The exact date on which the event occurred. Dates are always in the UTC timezone. The format is MM/DD/YYYY HH:mm.
- ► event_user_is_anonymous
- True (t) if the user is anonymous. False (f) if the user is logged in.
- ► event_session_id
- A cookie is stored in the user's browser to identify the user whether or not the user logged in. Used to track a particular user across multiple requests.
- ► event_parameter_origin
- A parameter used to capture the origin of the request. The parameter of
example.com/@api/deki/pages/123/contents?origin=CustomIntegrationyields a value of "CustomIntegration." Some examples are:
Origin Description mt-web The request originated from a browser. mt-f1 The request originated from MindTouch contextual help. Blank The request came from an unknown origin.
- ► helprequest_origin_type
- The classification of the previously mentioned
event_parameter_origin. This buckets the origins to view the collection on a less granular level. The following is a list of types:
Type Description WEB The request originated from a browser. F1 The request originated from MindTouch contextual help. CUSTOM The request came from a custom origin parameter. INVALID The origin parameter was deemed invalid. You can review invalid origin types here. BLANK If there is no origin parameter the origin type will be unclassified.
- ► event_ip
- The IP address where the request originated from.
- ► event_page_path
- The page path involved in the request. This is only applicable for page and PDF views. An empty path is used to identify the home page. We recommend using the Page ID to track pages. An author may change the page path, but the ID remains the same.
- ► event_type
- The unique type of event. The following are possible values:
Event Type Description page:view The request originated from a browser (the default way your content is viewed). page.content:rendered A page was rendered through the API (a custom integration where your content is viewed on a different property). search:query A search was performed in the MindTouch interface or the site/search endpoint. search:index A search was performed using Opensearch or using the site/query endpoint. These are likely searches performed by an integration. pdf:book Occurs when a PDF book is generated that contains multiple MindTouch pages. pdf:page This event shows when a user views a PDF of a MindTouch page.