Interface UsageMeteringApiGetMonthlyUsageAttributionRequest

Hierarchy

  • UsageMeteringApiGetMonthlyUsageAttributionRequest

Properties

endMonth? fields includeDescendants? nextRecordId? sortDirection? sortName? startMonth tagBreakdownKeys?

Properties

Optional endMonth

endMonth?: Date

Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage ending this month.

fields

fields: MonthlyUsageAttributionSupportedMetrics

Comma-separated list of usage types to return, or * for all usage types.

Optional includeDescendants

includeDescendants?: boolean

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

Optional nextRecordId

nextRecordId?: string

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

Optional sortDirection

sortDirection?: UsageSortDirection

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

Optional sortName

sortName?: MonthlyUsageAttributionSupportedMetrics

The field to sort by.

startMonth

startMonth: Date

Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning in this month. Maximum of 15 months ago.

Optional tagBreakdownKeys

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.

Settings

Member Visibility

Theme

Generated using TypeDoc