The Get System Statistics API

Using the Get System Statistics API, you can view the statistics of a system.
METHOD GET
URI 
https://<historianservername>/historian-rest-api/v1/systemstats
SAMPLE QUERY PARAM GET URL 
https://<historianservername>/historian-rest-api/v1/systemstats
SAMPLE RESPONSE 
{

    "ErrorCode": 0,

    "ErrorMessage": null,

    "Data": {

        "Utilization": {

            "WriteCacheHitRatio": "0.499",

            "SpaceConsumptionRate": "",

            "CompressionRatio": "0.199",

            "ReadQueueSize": "0",

            "WriteQueueSize": "0",

            "MsgQueueSize": "0",

            "ReadQueueProcessRate": "3",

            "WriteQueueProcessRate": "0",

            "MsgQueueProcessRate": "0",

            "MemoryVMUsage": "62",

            "OutOfOrderRate": "0",

            "ReadThreadUsage": "0",

            "WriteThreadUsage": "0",

            "FailedWriteRate": "0",

            "DiskFreeSpace": "59828"

        },

        "AlarmEvents": {

            "AverageAlarmRate": ""

        },

        "TotalCollectors": {

            "TotalCollectors": 1,

            "RunningCollectors": 1,

            "StoppedCollectors": 0,

            "UnknownCollectors": 0

        },

        "Licence": {

            "ActualDataStores": 3,

            "MaxDataStores": 200,

            "ActualTags": 0,

            "MaxTags": 2147483647,

            "ActualUsers": 0,

            "MaxUsers": 1000

        }

    }

}
SAMPLE cURL COMMAND 
curl -i -H "Accept: application/json" -H "Authorization: Bearer <TOKEN>” 
https://<historianservername>/historian-rest-api/systemstats

Response Parameters

Parameter Data Type Required? Description
ErrorCode Integer Yes For example, ErrorCode = 0 implies the operation was successful.
ErrorMessage String Yes For example, NULL.