Introduction

This API allows customers who use an Offline Metered License, (or are considering migrating to such a license), to obtain product usage statistics.

Available URLs

GET /usageReport

If the Central Database is configured, obtains the report on how many documents were processed during the last 365 days (or, if the Central Database was initialized within that period, since the time it was initialized). If clustering is enabled, it returns the data for the whole cluster, otherwise it returns the data for the current PrizmDoc Server.

Usage records are aggregated per day, using UTC day boundaries. Product usage for the current UTC date is not included in the report to avoid getting different data for this date the next time the report is generated and modifying previously reported data in the Accusoft's product usage reports storage.

NOTE: You must configure the Central Database in order to use this API. This is also a requirement for using an Offline Metered License.

You can call this endpoint as many times as you want; no usage data is removed from the database as a result of this call.

See Offline Metered License on how to provide the usage report to Accusoft.

NOTE: Use of a Central Database for PrizmDoc will be required in a future release in order to move towards eliminating server affinity.

Successful Response

The response body will contain product usage statistics in JSON format. The contents of the report are unencrypted; however, they are application specific and can be changed by Accusoft in the future.

Example

Request

GET http://prizmdoc_server_base_url/usageReport

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "reports": [
    {
      "count": {
        "documentsProcessed": 3654
      },
      "duration": "1d",
      "period": "2022-10-06T00:00:00.000Z"
    },
    {
      "count": {
        "documentsProcessed": 827
      },
      "duration": "1d",
      "period": "2022-10-07T00:00:00.000Z"
    },
    ...
  ]
}

Error Responses