list usageRecordGroups
GET/org/:orgId/usageRecordGroup
List UsageRecordGroups by the given organization, partner, product, entitlement or buyer. Only provide one or none of the optional query parameters: partner, productId, entitlementId & buyerId .
Request
Path Parameters
Organization ID
Query Parameters
Possible values: [AWS
, AZURE
, GCP
]
Cloud Partner
filter by buyer ID, default no filter by buyerId if not provided
filter by entitlement ID, default no filter by entitlementId if not provided
Possible values: [CREATED
, DELETED
, INVALID
, REPORTED
, REPORT_PENDING
, REPORT_FAILED
]
The status of the usage record group, default no filter by status if not provided
Possible values: [``, API
, INTERNAL
, METRONOME
, ORB
]
The source of the usage record group, default no filter by source if not provided
metaInfo filter
start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate
end date (UTC) in YYYY-MM-DD format, default is today
List pagination size, default 1000, max value is 1000
List pagination offset, default 0
Responses
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
usageRecordGroups
object[]
metaInfo
object
If it is true, the validation of the usage record group is skipped.
billableRecords
object[]
for usage metering API v2
Key is the unique identifier of a billable metric.
properties
object
Properties is the filters of a billable metric. It should be equal to the filters of the billable metric.
Properties is the filters of a billable metric. It should be equal to the filters of the billable metric.
The quantity (or numeric value) of a billable metric.
The metronome daily cost amount (in dollars) of the customer.
The metronome monthly invoice amount (in dollars) of the customer. This field keeps the largest amount of the invoice month. So it can only be updated when the invoice month increases.
The metronome monthly invoice amount (in dollars) of the customer, which is adjusted by the seller. This field is populated only when the invoice amount is decreased by the seller via credit granting.
originRecords
object
The original records reported by the customer before convertion. If no dimension mapping is applied, this field is the same as the records field.
Possible values: [``, API
, INTERNAL
, METRONOME
, ORB
]
The timestamp (UTC)) of when the usage records were generated. Optional, if not provided, the current report timestamp will be used.
Possible values: [AWS
, AZURE
, GCP
]
records
object
{
"nextOffset": 0,
"usageRecordGroups": [
{
"buyerID": "string",
"creationTime": "2024-08-12T01:02:15.910Z",
"entitlementID": "string",
"id": "string",
"lastUpdateTime": "2024-08-12T01:02:15.910Z",
"metaInfo": {
"SkipValidation": true,
"billableRecords": [
{
"key": "string",
"properties": {},
"quantity": 0
}
],
"metronomeDailyCostAmount": 0,
"metronomeMonthlyInvoiceAmount": 0,
"metronomeMonthlyInvoiceAmountAdjusted": 0,
"originRecords": {},
"source": "",
"timestamp": "2024-08-12T01:02:15.910Z"
},
"organizationID": "string",
"partner": "AWS",
"records": {},
"serialID": 0,
"status": "string",
"usageRecordReportID": "string"
}
]
}
Bad request error
- application/json
- Schema
Schema
string
Internal server error
- application/json
- Schema
Schema
string