CustomerUsageDataJsonSchema
object
Metadata pertaining to the query.
Show 8 propertiesHide 8 properties
downloadbooleanRequired
Whether browser was indicated to download file
endstringRequiredformat: date
The end date of the query.
The filters applied to the query.
Show 3 propertiesHide 3 properties
meterNameslist of stringsRequired
Meter names the results were filtered to.
paymentMethodIdslist of stringsRequired
Payment method IDs the results were filtered to.
projectNameslist of stringsRequired
Project names the results were filtered to.
formatstringRequired
The output format. Either csv or json.
granularitystringRequired
The time bucket used for aggregation.
groupBylist of stringsRequired
The list of fields that the results are grouped by.
recordsintegerRequired
The number of result records returned.
startstringRequiredformat: date
The start date of the query.
The usage data per day per meter
Show 16 propertiesHide 16 properties
coststringRequired
Monetary value of usage for this record, in the currency specified by the currency field. How this is charged depends on the entitlement type: for a license entitlement the amount is fully covered and nothing is billed; for cash, quantity, or pre-commitment entitlements this amount is deducted from the entitlement balance; with no entitlement the amount is billed directly.
currencystringRequired
The currency of the cost field.
datestringRequiredformat: date-time
The date and time of this usage record. Truncated to the granularity of the query (e.g. if granularity is 'day' then time will be 00:00:00).
dateProcessedstring or nullOptionalformat: date-time
The report_time truncated to the requested granularity. Null for usage that has not yet been charged. Comparing against date (sample_time) reveals late-reported data.
entitlementstring or nullOptionalformat: uuid
The ID of the entitlement applied to this usage. Can be joined against the /entitlements endpoint.
entitlementTypestring or nullOptional
The type of entitlement applied to this usage, if any.
familystringOptional
Product family this meter belongs to.
meterNamestringRequired
The meter name.
meterSkustring or nullOptional
The SaaS SKU identifier for this meter.
paymentMethodstringOptionalformat: uuid
The ID of the payment method associated with this usage.
paymentMethodNamestring or nullOptional
The display name of the payment method associated with this usage.
pricedoubleOptional
Per-unit price for this record (cost / quantity).
projectstringOptional
The name of the project this usage belongs to.
quantitydoubleRequired
Total units accrued for this record.
solutionstringOptional
Solution within the product family this meter belongs to.
unitstring or nullOptional
The unit that this meter is reported in, e.g. 'gigabytes' or 'minutes'.