...
If you want to retrieve information about usage user history at a particular point in time, we recommend that you use the following URL request template.
...
- the possible parameters are as follows:
| Parameter | Required | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ${featureId} | Yes | integer | Specifies feature-specific parameters. | |||||||||
| ${returnType} | Yes | string | Specifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf. | |||||||||
| sdt | Yes | string | Specifies point in time for which you want to generate the report. The date and time format is as follows: YYYY-MM-DD HH:MM; for example, 2015-01-20 11:00. | |||||||||
| fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
where number "1" indicates that a specific field is visible. | |||||||||
| rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or Excel. | |||||||||
| filter | No | json/string | Applies filtering license usage data on all fields. To filter your data, use the following format:
| |||||||||
| limit | No | integer | Determines the maximum number of data records that can be returned. The value must be greater than zero. | |||||||||
| offset | No | integer | Specifies the offset of the first row to return. | |||||||||
| orderBy | No | string | Specifies the field by which you want to order your data records. The field name can be one of the following: uid, un, hn, sst, set. | |||||||||
| orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
If your request is successful, you should see a response similar to the following:
...
where the response fields can be explained as follows:
| Field | Type | Description |
|---|---|---|
| uid | integer | User Id. |
| un | string | Username. |
| hn | string | Hostname. |
| sst | string | Date returned in YYYY-MM-DD HH:MM format; for example, 2016-01-20 11:00. |
| set | string | Date returned in YYYY-MM-DD HH:MM format (for example, 2016-01-20 11:00), "Unknown", or "Still in use". |
| il | boolean | This field indicates whether user details have been imported from LDAP directory. Note that you cannot filter and order data by this field. |
| msg | string | Error message returned on failure. |
| success | boolean | This field indicates that the API request was successfully processed. |
Example 1
For example, say you would like to view all sessions for feature 3 at a specific time point. To generate such data, enter a command that is similar to the following:
...
- the possible parameters are as follows:
| Parameter | Required | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ${featureId} | Yes | integer | Specifies feature-specific parameters. | |||||||||
| ${returnType} | Yes | string | Specifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf. | |||||||||
| ssd | Yes | string | Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2016-01-20. | |||||||||
| sed | Yes | string | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2016-01-27. | |||||||||
| fieldsVisibility | Specifies field visibility settings, for example:
where number "1" indicates that a specific field is visible. | |||||||||||
| rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or Excel. | |||||||||
| filter | No | json/string | Applies filtering license usage data on all fields. To filter your data, use the following format:
| |||||||||
| limit | No | integer | Determines the maximum number of data records that can be returned. The value must be greater than zero. | |||||||||
| offset | No | integer | Specifies the offset of the first row to return. | |||||||||
| orderBy | No | string | Specifies the field by which you want to order your data records. The field name can be one of the following: uid, un, hn, sst, set. | |||||||||
| orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
If your request is successful, you should see a response similar to the following:
...
where the response fields can be explained as follows:
| Field | Type | Description |
|---|---|---|
| uid | integer | User Id. |
| un | string | Username. |
| hn | string | Hostname. |
| sst | string | Date returned in YYYY-MM-DD HH:MM format; for example, 2016-01-20 11:00. |
| set | string | Date returned in YYYY-MM-DD HH:MM format (for example, 2016-01-20 11:00), "Unknown", or "Still in use". |
| il | boolean | This field indicates whether user details have been imported from LDAP directory. Note that you cannot filter and order data by this field. |
| msg | string | Error message returned on failure. |
Example 1
For example, say you would like to view all sessions for feature 3 over some period of time. To generate such data, enter a command that is similar to the following:
...