Based on HelpRequest activity, the HelpRequest usage logs show how often your MindTouch site content is used.
Access HelpRequest usage
Navigate to Dashboard > Reporting > HelpRequest usage.
The usage report contains:
- Usage to date: How many HelpRequests have been generated on your site since the start date of your license.
- Annually licensed: How many HelpRequests available to you in your license.
- Projected usage: How many HelpRequests you are calculated to use by the end of your license date.
- Start date: Beginning date of your license.
- End date: End date of your license.
- Actual vs. licensed usage chart: Compares your sites actual HelpRequest usage with your licensed usage amount.
- Channel table: Lists the different channels that generated HelpRequests for your site.
- Web help: View and search article/PDFs
- Contextual help: View and search within a contextual help box
- API: Any custom requests that have an origin
- [Additional rows]: Custom configured channels will appear on separate rows, such as Touchpoints, Salesforce, Zendesk, etc.
- Total: Total count of HelpRequests from the above list.
Download HelpRequest usage
If you do not see an option to download the report, contact the MindTouch Support Team.
- From the HelpRequest usage report, scroll down to the Report download section.
- Select a month from the dropdown menu and click Download.
Logs are updated at the end of every day and are delivered in .csv 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.
Unzip downloaded file
Look for a downloaded
.gzip file in your default downloads folder on your computer or default downloads folder in your browser.
Unzip for Mac:
- Navigate to your download folder.
- Double-click the file.
- Your operating system will automatically convert to a zip format.
- Unzip the file.
Unzip for 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.
The audit logs contain requests that MindTouch counts as HelpRequests.
- 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." Examples include:
- 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. Types include:
- 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. Values include:
- 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.