Displayr utilizes a usage-based pricing model, similar to a mobile phone plan or other utility in which the cost is based on how much you use it. When you purchase a Displayr license, one named user is entitled to 1,000 hours of usage over a 12-month period. This averages out to around 20 hours per week for the year. Time is consumed while you are using the Displayr. Optionally, time can also be purchased for people to view your documents online. This article explains various ways that you can track all the usage of users on your account, including both edit and view mode usage.
Usage bar in Edit mode
When you are editing your documents in Displayr (called Edit mode), a bar is shown in the top right corner of your screen to indicate how much Edit time you have remaining. If you hover your mouse over the bar a precise figure of remaining time appears.
In your Account Settings there is a section called Licenses . This section displays all of the licenses you have purchased, along with any additional purchased blocks of editing or viewing time. Each line contains details on the number of hours used and the hours remaining. To access a more detailed explanation hover the mouse over the numbers.
The Usage Page
The Usage section of your Account Settings page contains a list of all edit, view, and API sessions for your account. You can filter the report by selecting the start and end date/time. Users with Administrator access can also filter the usage for specific users. You can export the report as a CSV file by clicking the document icon to the right of the filters.
If you consume more than 50% of your hours before the middle of the year, you'll receive a notification by email. Notifications will then be sent by the Displayr system when your usage exceeds 80%, 90%, 95%, 99%, and 100% of allocated usage.
Tracking API Hours
Displayr does not track the time made for individual API calls. Rather, it tracks server time. Calling Displayr's API directly utilizes your view-mode hours which will appear in your Usage section under (API) as the User.
API usage against a Free document uses up the Free license view-mode hours. API usage against a Professional document uses up the Server time for private dashboards hours.
Viewing hours are computed based on the hours that the server hosting the document is active. When a document is initially published as a web page, a server starts to host the document. If no-one interacts further with the document through viewing pages or changing filters, for example, the server is shut down after 10 minutes. Later, if the published document is viewed, the server time starts again in order to provide data, and again the server is shut down after 10 minutes of inactivity. You can control this 10-minute period for each document by going to the Document Settings page, under Properties > When viewing this document, Displayr will stop your server after (minutes).
Note the instruction "While running, your server can respond without taking the time to start, but uses license minutes." There is a cost to starting a server and loading the required data. For example, if this time is set too low (e.g. 1 minute), it is likely that viewers of the document will see "Please wait" until the server starts.
Usage starts to be tracked as soon as the first API call is made. The server will then remains active for another 10 minutes. If you make another API call within the 10-minute period, the server continues to remain active for another 10 minutes. When the server finally shuts down, we subtract a grace period from the overall time period (typically 5 minutes).
So, for example, if you make an API call once an hour, you would expect to see a usage time of 5 minutes for each API call (server was started and active for 10 minutes - grace time of 5 minutes = usage of 5 minutes). After a day, you would expect to see 120 minutes of usage (5 minutes of usage per hour * 24 hours = 120 minutes).
If you wish to issue API calls every 5 minutes, this effectively means the document's server will remain active indefinitely (24 hours per day). After a day, you would expect to see a full 24 hours of usage. Over a year this will total to roughly 8,760 hours.
Dashboard Usage Statistics
You can also download a log of the different actions users are performing from the Dashboard Usage Statistics section at the bottom of this page. This log contains information about particular actions that individuals perform, for example:
- When a filter was applied
- Which Tab (page in the document) was viewed
- Which user was conducting each action
To obtain a log of detailed usage, select a date range to define the period for which you want to view the logs. Use the Type menu to choose whether you want to see View or Edit usage, and then click on the document icon at the top right to download a CSV file of the results. You can open the file in Excel or another spreadsheet application.
This report tracks when all documents are created, edited, and viewed. Select a date range from the filters and use the icon on the right to download the CSV file.