Get charts for the organization. Currently unavailable in self-hosted ECE.

edit

Get charts for the organization. Currently unavailable in self-hosted ECE.

edit

EXPERIMENTAL (it may change in future versions): Retrieves the usage charts for the organization.

Request

edit

GET /api/v1/billing/costs/{organization_id}/charts

Path parameters

edit
Name Type Required Description

organization_id

string

Y

Identifier for the organization

Query parameters

edit
Name Type Required Description

bucketing_strategy

string; allowed values: [daily, monthly]; default: "Daily"

N

The desired bucketing strategy for the charts. Defaults to daily.

from

string

N

A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month.

to

string

N

A datetime for the end of the desired range for which to fetch costs. Defaults to the current date.

Responses

edit
200

(ChartItems)

The usage charts of an organization.

400

(BasicFailedReply)

The specified date range is invalid. (code: costs.invalid_date_range)

Headers

x-cloud-error-codes (string; allowed values: [costs.invalid_date_range])
The error codes associated with the response
403

(BasicFailedReply)

The current user does not have access to the requested organization. (code: organization.invalid_access)

Headers

x-cloud-error-codes (string; allowed values: [organization.invalid_access])
The error codes associated with the response
404

(BasicFailedReply)

Organization not found. (code: organization.not_found)

Headers

x-cloud-error-codes (string; allowed values: [organization.not_found])
The error codes associated with the response
429

(BasicFailedReply)

Too many requests. (code: billing_service.rate_limited)

Headers

x-cloud-error-codes (string; allowed values: [billing_service.rate_limited])
The error codes associated with the response
500

(BasicFailedReply)

Error fetching the itemized costs for the organization. (code: billing_service.failed_request)

Headers

x-cloud-error-codes (string; allowed values: [billing_service.failed_request])
The error codes associated with the response

Request example

edit
curl -XGET https://{{hostname}}/api/v1/billing/costs/{organization_id}/charts \
-H "Authorization: ApiKey $ECE_API_KEY"