Skip to main content
POST
What the credential's workspace was charged per SKU for usage that started at or after start_time and before end_time, over each window of the period: the sum of the charges to its balance.

Authorizations

Authorization
string
header
required

A user session token or personal API key.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json

cf. AWS Cost Explorer GetCostAndUsage (TimePeriod, Granularity, GroupBy, Filter).

name
string
startTime
string<date-time>

Charges for usage that started at or after start_time and before end_time, as in QueryUsage.

Example:

"2023-01-15T01:30:15.01Z"

endTime
string<date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (Z); input may use an offset from UTC.

Example:

"2023-01-15T01:30:15.01Z"

granularity
enum<string>

The windows the period is cut into; unspecified sums the whole period as one.

Available options:
GRANULARITY_UNSPECIFIED,
GRANULARITY_HOURLY,
GRANULARITY_DAILY,
GRANULARITY_MONTHLY
groupBy
enum<string>[]

What each window's charges are further summed by, besides their SKU.

A fact of usage it may be summed by, besides its SKU and window.

cf. AWS Cost Explorer GroupBy dimension keys; Cloud Billing's export columns.

Available options:
USAGE_DIMENSION_UNSPECIFIED,
USAGE_DIMENSION_SUBJECT,
USAGE_DIMENSION_PRINCIPAL,
USAGE_DIMENSION_RESOURCE
filter
filter · object

Only charges matching every set list. Charges recorded before they carried their subject, principal and resource match none of those lists, and group under empty values.

Response

Success

cf. AWS Cost Explorer GetCostAndUsage ResultsByTime.

costs
Cost · object[]

One per window and SKU charged in it, by window, then SKU.