Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

Get organization usage costs

View as MarkdownEdit this pageReport an issueSet up docs MCP
GET/v1/organizations/{organizationId}/usageCost

Returns a grand total and a list of daily, per-entity organization usage cost records for the organization in the queried time period (maximum 31 days). All days in both the request and the response are evaluated based on the UTC timezone.

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the requested organization.

    format: uuid

Query parameters

  • from_datestringrequired

    Start date for the report, e.g. 2024-12-19.

    format: date
  • to_datestringrequired

    End date (inclusive) for the report, e.g. 2024-12-20. This date cannot be more than 30 days after from_date (for a maximum queried period of 31 days).

    format: date
  • filteroptionalarray ofstring

    Filter criteria to apply when retrieving the usage cost report. Currently, only filtering by resource tags is supported.

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalobject
    2 properties
    • grandTotalCHCoptionalnumber

      Grand total cost of usage in ClickHouse Credits (CHCs).

    • costsoptionalarray ofobject

      List of daily, per-entity usage cost records.

      9 properties
      • dataWarehouseIdoptionalstring

        ID of the dataWarehouse this entity belongs to (or is).

        format: uuid
      • serviceIdoptionalstring | null

        ID of the service this entity belongs to (or is). Set to null for dataWarehouse entities.

        format: uuid
      • dateoptionalstring

        Date of the usage. ISO-8601 date, based on the UTC timezone.

        format: date
      • entityTypeoptionaldatawarehouseorserviceorclickpipe

        Type of the entity.

      • entityIdoptionalstring

        Unique ID of the entity.

        format: uuid
      • entityNameoptionalstring

        Name of the entity.

      • metricsoptionalobject
        10 properties
        • storageCHCoptionalnumber

          Cost of storage in ClickHouse Credits (CHCs). Applies to dataWarehouse entities.

        • backupCHCoptionalnumber

          Cost of backup in ClickHouse Credits (CHCs). Applies to dataWarehouse entities.

        • computeCHCoptionalnumber

          Cost of compute in ClickHouse Credits (CHCs). Applies to service and clickpipe entities.

        • dataTransferCHCoptionalnumber

          Cost of data transfer in ClickHouse Credits (CHCs). Applies to clickpipe entities.

        • initialLoadCHCoptionalnumber

          Cost of initial load and resyncs in ClickHouse Credits (CHCs). Applies to clickpipe entities.

        • publicDataTransferCHCoptionalnumber

          Cost of data transfer in ClickHouse Credits (CHCs). Applies to service entities.

        • interRegionTier1DataTransferCHCoptionalnumber

          Cost of tier1 inter-region data transfer in ClickHouse Credits (CHCs). Applies to service entities.

        • interRegionTier2DataTransferCHCoptionalnumber

          Cost of tier2 inter-region data transfer in ClickHouse Credits (CHCs). Applies to service entities.

        • interRegionTier3DataTransferCHCoptionalnumber

          Cost of tier3 inter-region data transfer in ClickHouse Credits (CHCs). Applies to service entities.

        • interRegionTier4DataTransferCHCoptionalnumber

          Cost of tier4 inter-region data transfer in ClickHouse Credits (CHCs). Applies to service entities.

      • totalCHCoptionalnumber

        Total cost of usage in ClickHouse Credits (CHCs) for this entity.

      • lockedoptionalboolean

        When true, the record is immutable. Unlocked records are subject to change until locked.

Navigation