Returns resource quota usage metrics by entitlement for the specified day.
A resource quota is a fixed share of Intelligent Risk Platform system resources that is allocated to the tenant as part of an entitlement (e.g. RI-RISKMODELER, RI-UNDERWRITEIQ). To learn more about resource quotas see Resource Quota Management.
Usage metrics can be filtered by usageType: ModeledLocations, Jobs, and Storage. All usage metrics are filtered by date. If no date is specified, returns usage metrics for the current date.
Modeled Location metrics
A tenant is allocated a resource quota of ModeledLocationsCount as part of that tenant's RI-RISKMODELER or RI-UNDERWRITEIQ entitlement. This resource quota specifies the number of location exposures the tenant may model per day.
This operation returns the total number of locations modeled for the specified day.
| Metric | Description |
|---|---|
ModeledLocationsCount | Number of location exposures modeled. |
Job metrics and statistics
A tenant is allocated job quotas as part of that tenant's RI-RISKMODELER or RI-UNDERWRITEIQ entitlement. These job quotas specify the number of concurrent jobs that the tenant may run at any one time for both model jobs and non-model jobs as well as the total number of jobs that can be run per day. To learn more, see Platform Jobs.
Job usage metrics show information about jobs run by the tenant.
| Metric or Statistic | Description |
|---|---|
CancelledJobsCount | Total number of cancelled jobs. |
DailyJobsRun | Total number of jobs run. |
CompletedJobsCount | Total number of completed jobs. |
FailedJobsCount | Total number of failed jobs. |
ModelJobsCount | Total number of model jobs. |
ModelJobsMaxConcurrency | Job quota for maximum conurrent current model jobs. |
NonModelJobsCount | Total number of non-model jobs. |
NonModelJobsMaxConcurrency | Job quota for maximum concurrent non-model jobs. |
TotalDelayedJobsAverage | Average number of delayed jobs per hour. |
TotalJobsAverage | Average number of jobs per hour. |
TotalJobsCount | Total number of jobs. |
TotalJobsMaxConcurrency | Job quota for maximum concurrent total jobs (model and non-model). |
The ModelJobsMaxConcurrency, NonModelJobsMaxConcurrency, and TotalJobsMaxConcurrency metrics are only returned for RI-RISKMODELER entitlements.
Storage usage metrics
Storage usage metrics show information about the tenant's storage.
| Metric | Description |
|---|---|
ArchiveStorageInTbs | Size of archived data in TB. |
ExposureStorageInGB | Size of exposure data in GB. |
OtherStorageInGB | Size of other storage in GB. |
RecycleHubsizeInGb | Size of recycle hub in GB. |
TotalEdmsCount | Number of EDM data modules. |
This operation supports filtering by date and usage type.
/platform/tenantdata/v1/entitlements/{entitlement}/usages, CancelledJobsCount , CompletedJobsCount , ExposureStorageInGB , FailedJobsCount , ModelJobsCount , ModelJobsMaxConcurrency , ModeledLocations, ModeledLocationsCount , NonModelJobsCount , NonModelJobsMaxConcurrency , OtherStorageInGB, TotalDelayedJobsAverage , TotalEdmsCount , TotalJobsAverage , TotalJobsCount , TotalJobsMaxConcurrency , getusages, jobs, scope, storage, usageType