Skip to content

List hourly usage details.

POST
/api/web/namespaces/{namespace}/hourly_usage_details
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/example/hourly_usage_details \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "namespace": "example", "query": "example" }'

List the usage divided by hour. The usage is hourly aggregated, from the start of UTC hour to the end of UTC hour. It is used to see the detailed breakdown of the usage received from ListUsageDetails.

Examples of this operation.

namespace
required
string

Namespace Namespace.

Media typeapplication/json
ListHourlyUsageDetailsReq

Request body for ListHourlyUsageDetails rpc method.

object
namespace
Namespace

Namespace

string
>= 6 characters <= 1024 characters
query
query

Encoded query which is passed as is to barracute daemon.

string
<= 1024 characters
Examplegenerated
{
"namespace": "example",
"query": "example"
}

A successful response.

Media typeapplication/json
List Hourly Usage Details Response

Response body for ListHourlyUsageDetails rpc method.

object
hourly_usage_items
Usage items

Array of usage by hour in the period from the query.

Array<object>
Hourly usage item

One line of usage by an hour. One hour as the least resolution.

object
container
Container

Container name if this item correspond to the container usage. Otherwise it’s empty.

string
<= 1024 characters
deployment
Deployment

[x-required] Deployment name if this item correspond to the container usage. Otherwise it’s empty.

string
<= 1024 characters
end_timestamp
Timestamp end

End of the time unit.

string format: date-time
<= 1024 characters
quantity
Quantity

Quantity incurred.

number format: double
start_timestamp
Timestamp start

Beginning of the time unit.

string format: date-time
<= 1024 characters
unit_name
Unit name

Name of the quantity unit.

string
<= 1024 characters
Examplegenerated
{
"hourly_usage_items": [
{
"container": "example",
"deployment": "example",
"end_timestamp": "2026-04-15T12:00:00Z",
"quantity": 1,
"start_timestamp": "2026-04-15T12:00:00Z",
"unit_name": "example"
}
]
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example