KSC Open API
13.1
Kaspersky Security Center API description
|
The statistics, including the dashboards data, are formed in reply to the statistics data request.
To request dashboard data (by an appropriate interface method), use the "KLPPT_DASHBOARD" parameter (paramParams) of the request. For every requested dashboard, there must be an entry (paramParams) with a unique name (GUID) that contains the attributes, depending on the dashboard type, and which describes the requested dashboard according to the list of the dashboard's query attributes.
Here is a sample of the input parameters to request "Current state of the most anti-virus protection (number of hosts with status Critical, Warning and OK)" and "Distribution of virus activity in time" for 7 days (604800 seconds) before 23-03-2017 12:23:45:
+--- (paramParams) +---KLPPT_DASHBOARD (paramParams) +---4574FED1-ECC9-4f60-83D1-5BF5B84EB897 (paramParams) | +---KLRPT_DSH_TYPE = (paramInt)20 | +---id = (paramInt)0 | +---bIncludeVS = (paramBool)1 +---92A6E519-BF61-4902-B87D-A526FEFB91AA (paramParams) +---KLRPT_DSH_TYPE = (paramInt)2 +---KLPPT_StatFinishTime = (paramDateTime)23-03-2017 12:23:45 +---KLPPT_StatPeriodInSec = (paramInt)604800 +---id = (paramInt)-1 +---KLRPT_QUERY_ID = (paramInt)12
Here is a sample of the output dashboard parameters (inside output statistics data) that match the input parameters sample above:
+--- (paramParams) +---KLPPT_DASHBOARD (paramParams) +---4574FED1-ECC9-4f60-83D1-5BF5B84EB897 (paramParams) | +---KLRPT_DSH_TYPE = (paramInt)20 | +---id = (paramInt)0 | +---bIncludeVS = (paramBool)1 | +---nCrtCount = (paramInt)0 | +---nWrnCount = (paramInt)2 | +---nOkCount = (paramInt)10234 +---92A6E519-BF61-4902-B87D-A526FEFB91AA (paramParams) +---KLRPT_DSH_TYPE = (paramInt)2 +---KLPPT_StatFinishTime = (paramDateTime)23-03-2017 12:23:45 +---KLPPT_StatPeriodInSec = (paramInt)604800 +---id = (paramInt)-1 +---KLRPT_QUERY_ID = (paramInt)12 +---DSHT_DATA (paramArray) +---0 (paramParams) | +---nCount = (paramInt)0 | +---tmFinish = (paramDateTime)23-03-2017 17:22:58 | +---tmStart = (paramDateTime)23-03-2017 16:22:58 +---1 (paramParams) | +---nCount = (paramInt)12 | +---tmFinish = (paramDateTime)23-03-2017 18:22:58 | +---tmStart = (paramDateTime)23-03-2017 17:22:58 ... +---23 (paramParams) +---nCount = (paramInt)0 +---tmFinish = (paramDateTime)24-03-2017 16:22:58 +---tmStart = (paramDateTime)24-03-2017 15:22:58