Skip to content
Nexa Platform Docs

Get Warehouse Metering

GET
/api/v1/usage/warehouse-metering
curl --request GET \
  --url 'https://example.com/api/v1/usage/warehouse-metering?start_date=2026-04-15T12%3A00%3A00Z&end_date=2026-04-15T12%3A00%3A00Z'

Get warehouse metering history showing credit usage.

This endpoint queries WAREHOUSE_METERING_HISTORY to provide hourly credit consumption data for warehouses.

Args: start_date: Start date for the query end_date: End date for the query warehouse_name: Optional warehouse name filter

Returns: WarehouseMeteringResponse with metering records and totals

Raises: HTTPException: If query fails

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
start_date
required
Start Date

Start date for the query

string format: date-time

Start date for the query

end_date
required
End Date

End date for the query

string format: date-time

End date for the query

warehouse_name
Any of:
string

Optional warehouse name filter

Header Parameters

Section titled “Header Parameters”
X-Environment-Id
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WarehouseMeteringResponse

Response model for warehouse metering history.

object
records
required
Records

List of metering records

Array<object>
WarehouseMeteringRecord

Warehouse metering record model.

object
start_time
required
Start Time

Start of the hour

string format: date-time
end_time
required
End Time

End of the hour

string format: date-time
warehouse_id
required
Warehouse Id

Warehouse ID

integer
warehouse_name
required
Warehouse Name

Warehouse name

string
credits_used
required
Credits Used

Total credits used (compute + cloud services)

number
credits_used_compute
required
Credits Used Compute

Credits used for compute

number
credits_used_cloud_services
required
Credits Used Cloud Services

Credits used for cloud services

number
credits_attributed_compute_queries
Any of:
number
total_credits
required
Total Credits

Total credits across all records

number
total_compute_credits
required
Total Compute Credits

Total compute credits

number
total_cloud_services_credits
required
Total Cloud Services Credits

Total cloud services credits

number
warehouse_name
Any of:
string
start_date
required
Start Date

Query start date

string format: date-time
end_date
required
End Date

Query end date

string format: date-time
record_count
required
Record Count

Number of records

integer
Examplegenerated
{
  "records": [
    {
      "start_time": "2026-04-15T12:00:00Z",
      "end_time": "2026-04-15T12:00:00Z",
      "warehouse_id": 1,
      "warehouse_name": "example",
      "credits_used": 1,
      "credits_used_compute": 1,
      "credits_used_cloud_services": 1,
      "credits_attributed_compute_queries": 1
    }
  ],
  "total_credits": 1,
  "total_compute_credits": 1,
  "total_cloud_services_credits": 1,
  "warehouse_name": "example",
  "start_date": "2026-04-15T12:00:00Z",
  "end_date": "2026-04-15T12:00:00Z",
  "record_count": 1
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}