Get usage metrics by date

get https://{host}/platform/tenantdata/v1/entitlements/{entitlement}/usages/{usageType}/timevalues

Returns resource quota usage metrics over a specified date range.

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.

This operation returns information about resource quota usage metrics over time.

Different metrics are returned depending on the value specified in usageType path parameter: modeledLocations, Jobs, or Storage.

Modeled Locations Metrics

Returns the following metrics if the modeledLocations usage type is specified as a path parameter:

Property	Description
`ModeledLocationsCount`	Number of modeled locations per hour/day.

Jobs Metrics

Returns the following metrics if the Jobs usage type is specified as a path parameter:

Property	Description
`CancelledJobsCount`	Number of cancelled jobs per hour/day.
`CompletedJobsCount`	Number of completed jobs per hour/day.
`FailedJobsCount`	Number of failed jobs per hour/day.
`ModelJobsCount`	Number of model jobs run per hour/day.
`ModelJobsMaxConcurrency`	Quota of maximum concurrent model jobs.
`NonModelJobsCount`	Number of non-model jobs per hour/day.
`NonModelJobsMaxConcurrency`	Quota for maximum concurrent non-model jobs.
`TotalJobsCount`	Number of total jobs (model and non-model) run per hour/day.
`TotalJobsMaxConcurrency`	Quota for maximum concurrent total jobs.

Storage Metrics

Returns the following metrics if the Storage usage type is specified as a path parameter:

Property	Description
`ExposureStorageInGB`	Exposure storage capacity per hour/day.
`OtherStorageInGB`	Other storage capacity (e.g. analysis results) per hour/day.
`TotalEdmsCount`	Number of EDMs per hour/day.

Response

Returns an array of arrays of double values.

The first element represents the Unix time. The second element represents the metric value.

[
  [171884160000.0, 137.0],
  [171892800000.0, 12.0],
  [171901450000.0, 0.0]
]

The metric values returned in the response depend on the scope of the query.

If the rangeStart and rangeEnd query parameters specify a range of dates, the response returns metric values that identify daily metrics, e.g. the number of completed jobs per day.
If the query parameter specifies a single day (a period of less than 24 hours), the response returns metrics values the identify hourly metrics, e.g. the number of completed jobs per hour.

Language

Credentials

URL