The Get Read Sample and Receive Rate API

Using the Get Read Sample and Receive Rate API, you can view the read rate and receive rate of a system.
METHOD GET
URI
Read Sample Rate
https://<historianservername>/historian-rest-api/v1/performancecounter/perftagdata/
PerfTag_AverageEventRate/-/-/starttime/endtime/interval
Receive Rate
https://<historianservername>/historian-rest-api/v1/performancecounter/perftagdata/
PerfTag_AverageReadRawRate/-/-/starttime/endtime/interval
SAMPLE GET URI
https://<historianservername>/historian-rest-api/v1/performancecounter/
perftagdata/PerfTag_AverageEventRate/-/-/2020-12-15T11:19:01.719Z/2020-12-15T12:19:01.719Z/360000
SAMPLE RESPONSE
{

    "ErrorCode": 0,

    "ErrorMessage": null,

    "Data": [

        {

            "TagName": "PerfTag_AverageEventRate",

            "ErrorCode": 0,

            "DataType": "DoubleFloat",

            "Samples": [

                {

                    "TimeStamp": "2020-11-18T05:35:22.612Z",

                    "Value": "0",

                    "Quality": 0

                },

                {

                    "TimeStamp": "2020-11-18T05:47:22.612Z",

                    "Value": "0",

                    "Quality": 0

                },

                {

                    "TimeStamp": "2020-11-18T05:53:22.612Z",

                    "Value": "0",

                    "Quality": 0

                },             

                {

                    "TimeStamp": "2020-11-18T06:11:22.612Z",

                    "Value": "0",

                    "Quality": 0

                },

                {

                    "TimeStamp": "2020-11-18T06:29:22.612Z",

                    "Value": "0",

                    "Quality": 0

                }

            ]

        }

    ]

}

SAMPLE cURL COMMAND
curl -i -H "Accept: application/json" -H "Authorization: Bearer <TOKEN>” https://<historianservername>/historian-rest-api/v1/performancecounter/perftagdata/
PerfTag_AverageEventRate/-/-/2020-12-15T11:19:01.719Z/2020-12-15T12:19:01.719Z/360000

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.