Search Metrics
DescriptionYou can start a search to get a sortable, filterable and paginated list of metrics in an organization
Request
URLURL
Path Parameters
Path Parameters
Unique identifier (GUID) of the organization
Query Parameters
Query Parameters
Filtering criteria for the paginated request in the format: “property,eq(:value)”. For multiple filter criteria: “filter=property1,eq(:value)&filter=property2,eq(:value)”. Supported filtering properties are “metric_id, service_definition_id, seller_id, usage_date_time, commit_quantity, usage_quantity, overage_quantity, status. A property may be specified multiple times to match against multiple values”
Locale with language preference (e.g. en_US)
The index of requested page (0-based). Default = 0
Size of each page. Default = 20
Sorting criteria for the paginated request in the format: “property(,asc|desc)”. For multiple sort criteria: “sort=property1(,asc|desc)&sort=property2(,asc|desc)”. Supported sorting properties are “metric_id, service_definition_id, seller_id, usage_date_time, commit_quantity, usage_quantity, overage_quantity, status”. Default is “metric_id,asc”
Request Body
JSON object containing filter criteria as charge attributes
{
"charge_attributes": {
"aws_region": "EU_WEST_3",
"category": "HOST_USAGE"
}
}
Charge Attributes of a Metric
Response
Response BodyResponse Body
200 OK
{
"content": [
{
"metadata": {
"charge_attributes": {
"key": "string"
},
"display_name": "string",
"metric_id": "string",
"service_definition_id": "string",
"unit_of_measure_display_name": "string"
},
"usage": {
"commitment": 0,
"last_updated": "string",
"overage": 0,
"partner_id": "string",
"seller": "string",
"seller_id": "string",
"status": "OVER_COMMITMENT",
"subscriptions": [
{
"billing_engine_subscription_id": "string",
"subscription_id": "string"
}
],
"usage": 0
}
}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"number_of_elements": 0,
"pageable": {
"offset": 0,
"page_number": 0,
"page_size": 0,
"paged": false,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"unpaged": false
},
"size": 0,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"total_elements": 0,
"total_pages": 0
}
Whether there is no item to be returned
Whether user request the first page
Whether user request the last page
Number of requested page (0-based)
The number of MetricUsage items as the result of filter/sort/pagination operations. If there are no such operations, it will be equal to total_elements.
Size of each page
Total number of results
Total number of pages
Errors
Bad Request
Unauthorized
Forbidden
