ReportingCloud

Transactions and Statistics

Topic

Knowing how many documents your applications create, and with which API key, helps you choose the right plan and find the client that uses more than expected. The ReportingCloud portal keeps two views of your Web API usage: the Transaction Monitor lists every request of the current month, and Statistics sums up the quota usage per month, for the current month and for earlier ones.

What a Transaction Is

Each request to the Web API is a transaction, which the portal records with its time, its result, the IP address it came from and the API key it used. This transaction log helps you and Text Control track down problems. ReportingCloud never stores the merge data or the documents it creates, as Data Security and Privacy explains.

Some transactions count against a quota of your plan: each successful request of the document endpoints, such as merge, convert and append, against the document quota, each spell checking request against the spell checking quota and each uploaded template against the template storage quota. What Counts Against Which Quota lists the endpoints of each quota, and Test Mode the requests that don't count.

The Transaction Monitor

Click Transaction Monitor in the side menu. The page lists the transactions of the current month under All Transactions in and the name of the month.

Transaction Monitor listing this month's Web API transactions

ColumnContent
IDThe number of the transaction
Web API MethodThe method that was called, such as List or CreateAPIKey
SuccessTrue when the request succeeded
InformationDetails of the request, such as the API key it was sent with
IP AddressThe address the request came from
TimestampThe date and time of the request

A click on a column heading sorts the list by that column, and records per page sets how many transactions a page shows.

Find the Requests of One Application

The Information column shows the API key of each request made with one. If each application uses an API key of its own, you find its requests by the key:

  1. Copy the key of the application from Manage Account.
  2. Paste it into Search all columns, or into the filter box below the Information column.

The list then holds only the requests made with this key. The filter boxes of the other columns work the same way, for example Filter Web API Method for the requests of one method. Manage Account describes how to create a key per application.

The Statistics Page

Click Statistics in the Account section of the side menu. The page shows the usage of the current month, with the month and year in its title.

Statistics page with the month selection list open

  • The drop-down above the charts switches between Current Month to Date, a live view of the month so far, and the earlier months of your account. The complete statistics of a month are available on the first day of the next month.
  • The bar chart shows the quota requests of the month per method: Merge, Convert, Thumbnails, FindAndReplace, Check and Suggestions, with their total in the heading.
  • The pie chart Total Number of Requests shows the requests against the document quota of your plan, such as "0 of 1000" on a trial account.
  • Updated below each chart gives the time of the data in UTC.

Compare the monthly totals with the quotas of the plans before a subscription renews, to choose the plan that fits your usage.

Check the Usage From Code

The Transaction Monitor and the statistics have no Web API endpoints. For the current month, GET /v1/account/settings returns the usage counters: createdDocuments and proofingTransactions hold the usage of the current month, and maxDocuments and maxProofingTransactions the quotas. A script can compare them and warn you before a quota runs out; Read the Settings With the Web API shows the request and lists every property.

Next Steps