Statistics

Use this API to fetch the data for the provided statistics type in the 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

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

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/v3_monitor/statistics/{statisticType}

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

No Parameter fields are required

Request body

Field Name	Type	Description
statisticParameter	List(String)	The parameters which are respective to statistics type must be given properly. Some types may or may not have parameters. For device risk type alone it will have two parameters in list.

Statistic type

statisticType	statisticParameter
APP_CLIENT_TYPES	no parameters
APP_CLIENT_VERSIONS	one parameter - client type {ANDROID_ARM, WINDOWS, MAC_OS, ANDROID_x86, iOS_ARMv7s, iOS_ARM64,WindowsPhone_ARMV7, WindowsPhone_Emu, iOS_ARMv7}
FIRMWARE_VERSIONS	one parameter - device type {MIDENTITY_MINI, MIDENTITY_AIR_PLUS, MIDENTITY_AIR}
DEVICE_TYPES	no parameters
LOCKED_USERS	no parameters
LOCKED_DEVICES	no parameters
OS_VERSIONS	one parameter - client type {ANDROID_ARM, iOS_ARMv7, WINDOWS, MAC_OS, ANDROID_x86, iOS_ARMv7s, iOS_ARM64, WindowsPhone_ARMV7, WindowsPhone_Emu}
DEVICE_RISKS	two parameters - start date (yyyy-MM-dd) and end date (yyyy-MM-dd)

Sample Request

{
  "statisticParameters": [
    "yyyy-MM-DD","yyyy-MM-DD"
  ]
}

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": 4,
  "status": "OK",
  "message": "Statistic data fetched successfully",
  "data": [
      {
          "Type": "ANDROID_ARM",
          "Count": "0"
      },
      {
          "Type": "ANDROID_x86",
          "Count": "4"
      }
  ]
}

Response Status Information

Status Code	Status	Message
200	OK	Statistic data fetched successfully
400	BAD_REQUEST	Failed to convert value of type 'java.lang.String'
401	Unauthorized	HTTP 401 Unauthorized