API Performance

ReadPrfMemoryAvailable

Reads average memory available entries on the server for the time period. The StartDate and EndDate parameters should use the Sortable Date format with whole minutes and 00 for seconds, i.e. "yyyy-MM-ddTHH:mm:ss"

Authentication: Windows

Privilege : Administrator

Method: PxStat.Security.Performance_API.ReadPrfMemoryAvailable

Parameters:

Name	Type	Default	Description
`PrfDatetimeStart`	DateTime		Start of Date/Time range for this read ("YYYY-MM-DDTHH:mm:ss").
`PrfDatetimeEnd`	DateTime		End of Date/Time range for this read ("YYYY-MM-DDTHH:mm:ss").

Return: Object as below - Alternatively, an array of validation errors

Name	Type	Default	Description
datetime	String[]		An array of the minutes between the PrfDatetimeStart and PrfDatetimeEnd inclusive
server	Object[]		An array of server objects consisting of a servernamestring and the array of results for that server at the matching minute to datetime if exists otherwise null.

Return: Example is shown below:

{
    "jsonrpc": "2.0",
    "result": {
        "datetime": [
            "05/11/2020 15:36:00",
            "05/11/2020 15:37:00",
            "05/11/2020 15:38:00"
        ],
        "server": [
            {
                "SERVERNAME": [
                    "0",
                    "0",
                    null
                ]
            }
        ]
    },
}

ReadPrfRequestPerSecond

Reads average requests per second entries on the server for the time period. The StartDate and EndDate parameters should use the Sortable Date format with whole minutes and 00 for seconds, i.e. "yyyy-MM-ddTHH:mm:ss"

Authentication: Windows

Privilege : Administrator Method: PxStat.Security.Performance_API.ReadPrfRequestPerSecond

Parameters:

Name	Type	Default	Description
`PrfDatetimeStart`	DateTime		Start of Date/Time range for this read ("YYYY-MM-DDTHH:mm:ss").
`PrfDatetimeEnd`	DateTime		End of Date/Time range for this read ("YYYY-MM-DDTHH:mm:ss").

Return: Object as below - Alternatively, an array of validation errors

Name	Type	Default	Description
datetime	String[]		An array of the minutes between the PrfDatetimeStart and PrfDatetimeEnd inclusive
server	Object[]		An array of server objects consisting of a servernamestring and the array of results for that server at the matching minute to datetime if exists otherwise null.

Return: Example is shown below:

{
    "jsonrpc": "2.0",
    "result": {
        "datetime": [
            "05/11/2020 15:36:00",
            "05/11/2020 15:37:00",
            "05/11/2020 15:38:00"
        ],
        "server": [
            {
                "SERVERNAME": [
                    "0",
                    "0",
                    null
                ]
            }
        ]
    },
}

ReadPrfRequestQueue

Reads average requests queued on the server for the time period. The StartDate and EndDate parameters should use the Sortable Date format with whole minutes and 00 for seconds, i.e. "yyyy-MM-ddTHH:mm:ss"

Authentication: Windows

Privilege : Administrator

Method: PxStat.Security.Performance_API.ReadPrfRequestQueue

Parameters:

Name	Type	Default	Description
`PrfDatetimeStart`	DateTime		Start of Date/Time range for this read ("YYYY-MM-DDTHH:mm:ss").
`PrfDatetimeEnd`	DateTime		End of Date/Time range for this read ("YYYY-MM-DDTHH:mm:ss").

Return: Object as below - Alternatively, an array of validation errors

Name	Type	Default	Description
datetime	String[]		An array of the minutes between the PrfDatetimeStart and PrfDatetimeEnd inclusive
server	Object[]		An array of server objects consisting of a servernamestring and the array of results for that server at the matching minute to datetime if exists otherwise null.

Return: Example is shown below:

{
    "jsonrpc": "2.0",
    "result": {
        "datetime": [
            "05/11/2020 15:36:00",
            "05/11/2020 15:37:00",
            "05/11/2020 15:38:00"
        ],
        "server": [
            {
                "SERVERNAME": [
                    "0",
                    "0",
                    null
                ]
            }
        ]
    },
}

ReadPrfProcessorPercentage

Reads average percentage of processor used on the server for the time period. The StartDate and EndDate parameters should use the Sortable Date format with whole minutes and 00 for seconds, i.e. "yyyy-MM-ddTHH:mm:ss"

Authentication: Windows

Privilege : Administrator

Method: PxStat.Security.Performance_API.ReadPrfProcessorPercentage

Parameters:

Name	Type	Default	Description
`PrfDatetimeStart`	DateTime		Start of Date/Time range for this read ("YYYY-MM-DDTHH:mm:ss").
`PrfDatetimeEnd`	DateTime		End of Date/Time range for this read ("YYYY-MM-DDTHH:mm:ss").

Return: Object as below - Alternatively, an array of validation errors

Name	Type	Default	Description
datetime	String[]		An array of the minutes between the PrfDatetimeStart and PrfDatetimeEnd inclusive
server	Object[]		An array of server objects consisting of a servernamestring and the array of results for that server at the matching minute to datetime if exists otherwise null.

Return: Example is shown below:

{
    "jsonrpc": "2.0",
    "result": {
        "datetime": [
            "05/11/2020 15:36:00",
            "05/11/2020 15:37:00",
            "05/11/2020 15:38:00"
        ],
        "server": [
            {
                "SERVERNAME": [
                    "0",
                    "0",
                    null
                ]
            }
        ]
    },
}