CustomerUsageQueryData

object

downloadbooleanOptionalDefaults to false

When true, sets response headers to prompt a browser file download.

endDatestringRequiredformat: date

End date of the usage report (exclusive). This use to be inclusive. To get a full month of usage, set both startDate and endDate to the first of the month. Maximum range depends on granularity: 31 days for 'hour', 1 year for 'day', unlimited for 'week', 'month', or 'year'.",

filterOnReportedDatebooleanOptionalDefaults to false

When true, filters usage by report_time (when the usage was charged) rather than sample_time (when it occurred). Useful for reconciling against invoice dates. Defaults to false.

formatenumOptionalDefaults to json

Response format. Either 'json' or 'csv'. Defaults to 'json'.

Allowed values:jsoncsv

granularityenumOptionalDefaults to day

Time bucket for aggregation. Defaults to 'day'.

Allowed values:yearmonthweekdayhour

groupBylist of stringsOptional

Fields to group results by. Only 'meter' is currently valid. Defaults to ['meter'].

meterNameslist of stringsOptional

Filter results to the specified meter names.

paymentMethodIdslist of stringsOptional

Filter results to the specified payment method IDs. Mutually exclusive with projectNames.

projectNameslist of stringsOptional

Filter results to the specified project names. Mutually exclusive with paymentMethodIds.

startDatestringRequiredformat: date

Start date of the usage report (inclusive).