Statistics List

Use this API to fetch the list of data for the provided request.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

GET https://{tenantId}.{hostname}/digitanium/v4/monitor/statistics

OR

GET https://{tenantId}.{hostname}/digitanium/v4/monitor/statistics?fromdate=<yyyy-MM-DD>&todate=<yyyy-MM-DD>

HTTP request URL for SHIFT

GET https://{hostname}/auth/realms/{tenantId}/v3_monitor/statistics?fromdate=<yyyy-MM-DD>&todate=<yyyy-MM-DD>

note

At this moment, this API is applicable only for SSMS based installations.

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

Parameter Name	Type	Description
fromdate	String	provide fromdate for device risk (Query parameter)
todate	String	provide todate for device risk (Query parameter)

Note: Device risk data will be retrieved only if fromdate and todate are not null.

Request body

No request body fields are required.

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.
data	Array	List of all details for the given statisticType.

Sample Response

{
    "subSystem": 2,
    "status": "OK",
    "message": "Received response!",
    "data": {
         "DEVICE_RISKS": [
            {
            "Start date": "2019-05-10",
            "End date": "2019-06-10",
            "Risk": "JBreak",
            "Count": "0"
            },
            {
            "Start date": "2019-05-10",
            "End date": "2019-06-10",
            "Risk": "Manipulation",
            "Count": "0"
            }
         ],
        "APP_CLIENT_VERSIONS": [
            {
                "Client type": "MAC_OS",
                "Version": "Total",
                "App Name": "",
                "Count": "0"
            }
        ],
        "DEVICE_TYPES": [
            {
                "Type": "MIDENTITY_MINI",
                "Count": "0"
            },
            {
                "Type": "VIRTUAL_DEVICE",
                "Count": "1"
            },
        ],
        "LOCKED_DEVICES": [
            {
                "Devices": "PIN was wrong",
                "Count": "0"
            },
            {
                "Devices": "Total devices",
                "Count": "1"
            }
        ],
        "OS_VERSIONS": [
            {
                "Client type": "WindowsPhone_Emu",
                "Version": "Total",
                "Count": "0"
            }
        ],
        "LOCKED_USERS": [
            {
                "Users": "Locked: Retry Counter",
                "Count": "0"
            },
        ],
        "FIRMWARE_VERSIONS": [
            {
                "Device type": "MIDENTITY_AIR_PLUS",
                "Version": "Total",
                "Count": "0"
            }
        ],
        "APP_CLIENT_TYPES": [
            {
                "Type": "ANDROID_ARM",
                "Count": "0"
            },
            {
                "Type": "Total",
                "Count": "1"
            }
        ]
    }
}

Response Status Information

Status Code	Status	Message
200	OK	Statistic data fetched successfully
400	BAD_REQUEST	Invalid statisticParameters for statisticTypeInfo
401	Unauthorized	HTTP 401 Unauthorized