Interface UsageMeteringApiGetMonthlyUsageAttributionRequest

Hierarchy

  • UsageMeteringApiGetMonthlyUsageAttributionRequest

Properties

endMonth?: Date

Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]. If omitted or different from start_month, it is treated as equal to start_month. Only usage for start_month is returned; this parameter does not extend the requested range.

Comma-separated list of usage types to return, or * for all usage types. Usage types are in the format <usage_type>_usage and <usage_type>_percentage. Example: infra_host_usage,infra_host_percentage To obtain the complete list of usage attribution types that can be used to replace <usage_type> in the field names, make a request to the Get usage attribution types API.

includeDescendants?: boolean

Include child org usage in the response. Defaults to true.

nextRecordId?: string

List following results with a next_record_id provided in the previous query.

sortDirection?: UsageSortDirection

The direction to sort by: [desc, asc].

The field to sort by. Sort fields are in the format <usage_type>_usage. Example: infra_host_usage To obtain the complete list of usage attribution types that can be used to replace <usage_type> in the field names, make a request to the Get usage attribution types API.

startMonth: Date

Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for the month to retrieve. Maximum of 15 months ago. Only one month is supported per request.

tagBreakdownKeys?: string

Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags.

To see which tags are available, look for the value of tag_config_source in the API response.

Generated using TypeDoc