Audit tool for oneWEX

You can use the Watson Explorer API to obtain usage statistics for your Watson Explorer oneWEX installation.

About this task

You can use the audit tool to measure your use of the product against the entitlement terms in your license agreement with IBM®. The audit tool can help you distinguish between collections that count against the entitlement terms and collections that do not:
  • Collections that contain indexed content, such as collections that you create in the Watson Explorer administration console, count against your entitlement.
  • Collections that you analyze by using the natural language processing (NLP) API might count against your entitlement:
    • You can use the NLP API to do ad hoc text analytics on documents instead of adding the documents to the index. In this case, the collections that you analyze count against your entitlement.
To assess product usage, you or an auditor must measure all usage and calculate the volume that counts against the terms of entitlement in your license agreement with IBM.

NLP API usage is available on the System tab. For more information, see System. Indexed usage can be found using the Watson Explorer oneWEX API. This method also provides NLP API usage. For instructions on how to use this API tool, see the following instructions.

Procedure

  1. Access the Watson Explorer API at http://<hostname>/docs/.
  2. Click Authorize and enter your Watson Explorer credentials.
  3. Scroll down the page to System and click Get system usage.
  4. Click Try it out and then click Execute.

Results

The Response body section of Server response displays indexed usage in the datasetMetrics section and NLP API usage in the nlpMetrics section. The fields in the JSON output are described here.
datasetMetrics
totalSize
Total size of datasets in bytes.
limit
Maximum dataset size. If the dataset size exceeds this value, you cannot add documents to the dataset. If there is no limit, set this value to -1.
datasets
dsid
Dataset ID.
size
Dataset size in bytes.
lastUpdate
Timestamp of last update in milliseconds.
nlpMetrics
totalCount
Total cumulative request counts.
totalInputSize
Total cumulative size of input documents.
totalOutputSize
Total cumulative size of output documents.
collections
cid
Collection ID.
count
Cumulative request counts.
inputSize
Cumulative size of input documents in bytes.
outputSize
Cumulative size of output documents in bytes.
lastUpdate
Timestamp of last update in milliseconds.

A sample output is shown here.

{  
   "datasetMetrics":{  
      "totalSize":233678370,
      "limit":-1,
      "datasets":[  
         {  
            "dsid":"3dbf7d7d-b9d2-1180-0000-01626aa76bb4",
            "size":218932052,
            "lastUpdate":1522207925444
         },
         {  
            "dsid":"3dbf7d7d-b9d2-1180-0000-01622db0e642",
            "size":4915352,
            "lastUpdate":1521190480426
         },
         {  
            "dsid":"3dbf7d7d-b9d2-1180-0000-0162286adc51",
            "size":4915352,
            "lastUpdate":1521096978718
         },
         {  
            "dsid":"3dbf7d7d-b9d2-1180-0000-0162287972fc",
            "size":4915352,
            "lastUpdate":1521104009405
         },
         {  
            "dsid":"3dbf7d7d-b9d2-1180-0000-01622f0a19a7",
            "size":262,
            "lastUpdate":1521207713687
         }
      ]
   },
   "nlpMetrics":{  
      "totalCount":11,
      "totalInputSize":2662,
      "totalOutputSize":9922,
      "collections":[  
         {  
            "cid":"3dbf7d7d-b9d2-1180-0000-0162286b3a85",
            "count":11,
            "inputSize":2662,
            "outputSize":9922,
            "lastUpdate":1521097317641
         }
      ]
   }
}