Skip to main content
MindTouch Success Center

HelpRequests in MindTouch

A HelpRequest is a measure of interaction with your MindTouch site.

A HelpRequest is an HTTP(s) request that is either a page view, an API page content request, a search query, or a PDF generation. Each of these actions constitutes a unique unit of help delivered to a user, either within your MindTouch site or via Touchpoints.

HelpRequest usage

Use the HelpRequest Usage report to see historical and projected HelpRequest usage.

Page views

MindTouch tracks content pages such as categories, guides, and articles as HelpRequests. Page templates, administrative, content management, and report pages do not count as HelpRequests.

Search

While a search query counts as a HelpRequest, scrolling or viewing subsequent pages on the search results page does not.

Files

MindTouch does not track file requests except for PDF-generated views of page content. Attaching a PDF document to a page does not count as a HelpRequest.

API

Only MindTouch API calls that fetch page content, conduct search queries, or generate PDF's are counted as HelpRequests. The affected API endpoints are:

// page contents
https://{hostname}/@api/deki/pages/{id}/contents
https://{hostname}/@api/deki/pages/{id}?include=contents

// search
https://{hostname}/@api/deki/site/search
https://{hostname}/@api/deki/site/query
https://{hostname}/@api/deki/site/opensearch

// pdf generated from page contents
https://{hostname}/@api/deki/pages/{id}/pdf
https://{hostname}/@api/deki/pages/{id}/book
  • Was this article helpful?