...
Showing sessions at a specific point in time
If you want to You can easily fetch metrics about usage history at a particular point in time, use the following URL request template. by calling this HTTP GET request:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
GET /api/v1/report/feature/${featureId}/user-history/${returnType}?sdt=${sessionDateTime}&(additional parameters, as needed) |
...
| 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: is in YYYY-MM-DD HH:MM format; for example, 2017-05-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 XLS. | |||||||||
| 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 (See this section for more field-specific information.) | |||||||||
| orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
...
Showing sessions over a specific time period
If you want to retrieve information You can easily fetch metrics about usage history over a specific period of time, use the following URL request templategiven timeframe by calling this HTTP GET request:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
GET /api/v1/report/feature/${featureId}/user-history/${returnType}?ssd=${sessionStartDate}&sed={sessionEndDate}&(additional parameters, as needed) |
...
| 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 The date is in YYYY-MM-DD format; for example, 2017-05-20. | |||||||||
| sed | Yes | string | Specifies the end date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-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 (See this section for more field-specific information.) | |||||||||
| orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
...