Feature Usage

Feature usage reports contain global and per device premium feature usage. There is no personally identifiable information in the reports. Devices and users are identified only by their internal UUIDs. Feature usage reports run automatically every Monday morning at 00:00:00 GMT. Ivanti EPMM keeps the last 25 weekly reports available for download.

Get API feature usage history

This API returns the list of all available report data file names. These file names can be used in the datafile parameter for feature usage API. The result is reverse sorted by job execution time (latest job first).

Required Role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: Other Roles

Role Description: View device feature usage data

HTTP method

GET

Request URI

api/v2/featureusage_history

Request parameters

Parameter

Description

Sample Value

adminDeviceSpaceId

Required

Parameter Type: Query

Data Type: Number

The effective device space ID to become when searching for devices, to which the user must belong to search for devices. The feature usage data contains entries for all active devices, which requires the user be a member of the Global space. Global space is always 1.

1

Response fields

Field

Description

totalCount

The total number of entries that the query matched.

resultCount

The number of entries that are being returned.

hasMore

Indicates that there are more entries available.

results

Results container.

    dataFileName

The name of the feature usage data file.

    dataFileDate

The timestamp of the feature usage data file.

Sample request and response

Request

curl -X GET -u <userName>:<password> "https://[Ivanti EPMM]/api/v2/featureusage_history?adminDeviceSpaceId=1"

Response

{

  "totalCount": 1,

  "resultCount": 1,

  "hasMore": false,

  "results": [

    {

      "dataFileName": "manual220.auto.mobileiron.com_20160807000000",

      "dataFileDate": "2016-08-07 00:00:00"

    }

  ]

}

Get API feature usage

This API returns the contents of the specified feature usage data file. If no data file is specified, the call returns the latest file contents.

Required Role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: Other Roles

Role Description: View device feature usage data

HTTP method

GET

Request URI

api/v2/featureusage

Request parameters

Parameter

Description

Sample Value

adminDeviceSpaceId

Required

Parameter Type: Query

Data Type: Number

The effective device space ID to become when searching for devices, to which the user must belong to search for devices. The feature usage data contains entries for all active devices, which requires the user be a member of the Global space. Global space is always 1.

1

format

Parameter Type: Query

Data Type: String

Default: json

This specifies the return data format of the feature usage report. The default format is JSON. CSV format may also be requested by setting "format=csv".

csv

datafile

Parameter Type: Query

Data Type: String

This specified the name of the feature report data file. If this parameter is not set, the last run feature report file will be returned.

app993.auto.mobileiron.com_20160411182400

Response fields

Field

Description

Ivanti EPMM Information Fields

coreFQDN

The external Ivanti EPMM FQDN.

coreVersion

The Ivanti EPMM version at the time the report was created.

coreLicenseKey

This is a placeholder field to be used at a later time.

reportRun

The UTC timestamp indicating when the report was created.

featuresGlobal Fields

userPortalCertAuth

Self service portal certificate authentication is enabled.

helpIos

[email protected] for iOS is enabled.

helpAndroid

[email protected] for Android is enabled.

featuresDevices Fields

deviceUUID

The internal unique identifier for the device.

userUUID

The internal unique identifier for the user.

registeredAt

The UTC timestamp of when the device was registered.

platform

The operating system of the device.

featureAppConnect

Indicates if one or more AppConnect configurations are associated with the device.

featureDocs

Indicates if one or more [email protected] configurations are associated with the device.

featureDocsAC

Indicates if one or more Exchange configurations containing a Sentry with attachment control enabled are associated with the device.

featureWeb

Indicates if one or more MobileIron [email protected] configurations are associated with the device.

featureTunnel

Indicates if one or more VPN configurations containing a MobileIron Tunnel connection type are associated with the device.

featureIdentity

Indicates if one or more Single Sign-On Account configurations are associated with the device.

Sample requests and response

Requests

curl -X GET -u <userName>:<password> "https://[Ivanti EPMM]/api/v2/featureusage?adminDeviceSpaceId=1"

 

curl -X GET -u <userName>:<password> "https://[Ivanti EPMM]/api/v2/featureusage?format=csv&datafile=app993.auto.mobileiron.com_20160411182400&adminDeviceSpaceId=1"

Response to first example

{

  "coreFQDN": "manual220.auto.mobileiron.com",

  "coreVersion": "9.1",

  "coreId": "fd1caa40-3491-4b27-b721-f82763f67967",

  "coreLicenseKey": "demo-key",

  "reportRun": "2016-08-07 00:00:00",

  "featuresGlobal": {

    "userPortalCertAuth": false,

    "helpIos": true,

    "helpAndroid": false

  },

  "featuresDevices": [

    {

      "deviceUUID": "337f198a-f1bf-43a9-bc5e-09965e2a7124",

      "userUUID": "00b92e54-3374-469e-9996-b724b45a848a",

      "registeredAt": "2016-08-06 19:11:34",

      "platform": "Windows Phone 8",

      "featureAppConnect": "false",

      "featureDocs": "false",

      "featureDocsAC": "false",

      "featureWeb": "false",

      "featureTunnel": "true",

      "featureIdentity": "false"

    },

....

    {

      "deviceUUID": "7152a6bd-fc0e-4b42-85f7-2fcfee07f69a",

      "userUUID": "feb58faa-e52c-4e80-a9bf-5b11d9d15b6d",

      "registeredAt": "2016-08-06 06:08:01",

      "platform": "iOS",

      "featureAppConnect": "false",

      "featureDocs": "true",

      "featureDocsAC": "false",

      "featureWeb": "false",

      "featureTunnel": "false",

      "featureIdentity": "false"

    }

  ]

}