...
If your request is successful, you should see a response similar to the following:
| Code Block | ||
|---|---|---|
| ||
{
"success": ${success},
"msg": ${message},
"data": [
{
"fid": ${featureId},
"lud": ${date},
"lumin": ${minUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total}
}
],
"code": ${code},
"totalCount": ${count}
} |
...
| Field | Type | Description |
|---|---|---|
| success | boolean | This field indicates that the API request was successfully processed. |
| msg | string | Error message returned on failure. |
| fid | integer | Feature Id |
| lud | string | For Granularity hour - Datetime, for rest Date, which indicates point int time that data are about. |
| lumin | integer | Minimal licenses used count for given date. |
| lua | float | Average licenses used count for given date. |
| lumax | integer | Maximum licenses used count for given date. |
| lbmin | integer | Minimal licenses borrowed count for given date. |
| lbmax | integer | Maximum licenses borrowed count for given date. |
ldtc | integer | Denials count. |
| hu | float | Hours used. |
| ft | integer | Total. |
| code | integer | Error code if success == false, null otherwise. |
| totalCount | integer | Total number of rows returned. |
...
Usage History for Feature Comparison
If you want to obtain information about usage history for feature comparison, you have to use following URL request template.
| Code Block | ||
|---|---|---|
| ||
GET /api/v1/report/usage-history/comparison/json?fi=${featureIds}&sd=${startDate}&ed=${endDate}&granularity=${granularity} |