Lexicon Garden

at.happyproto.server.getUsage

One of the caller's instances' metered usage by hour or day, with the hours that have no report. Customers only.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · query
Kindquery
Authorityserver.happyproto.at
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

from

string · datetime

Start of the range. Defaults to one day before `to` at hour grain, 30 days at day grain.

grain

string

Defaults to hour. Hour ranges may span 31 days, day ranges 400.

  • knownValues: hour | day
  • enum: hour | day

id

requiredstring

The instance's UUID.

to

string · datetime

End of the range. Defaults to now.

Output

application/json

gaps

requiredarray
itemsref
Reference

grain

requiredstring
  • knownValues: hour | day

rows

requiredarray
itemsref
Reference

tenant

requiredstring

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

The caller is not a HappyProto customer, or the provisioner refused them.

InvalidRequest

id is not a UUID, or the range is backwards, too long, or has an unknown grain.

NotFound

No such instance, or it is not the caller's. The two are indistinguishable.

InvalidSlug

Passed through from the provisioner.

SlugTaken

Passed through from the provisioner.

NotEntitled

Passed through from the provisioner.

InstanceLimit

Passed through from the provisioner.

NoCapacity

Passed through from the provisioner.

OperationInProgress

Passed through from the provisioner.

Upstream

The provisioner could not complete the request.

#gap

object

Properties

hour

requiredstring · datetime

reason

requiredstring
  • knownValues: missing | agent_unreachable

#row

object

One hour or day of usage, summed across the tenant's hosts. `hour` is set at hour grain and `day` at day grain.

Properties

apiClients

integer

cpuUsec

requiredinteger

day

string

UTC date, YYYY-MM-DD.

diskAvgBytes

integer

diskPeakBytes

integer

egressBytes

requiredinteger

hour

string · datetime

ingressBytes

requiredinteger

memByteSeconds

requiredinteger

memPeakBytes

requiredinteger

partial

requiredboolean

Some samples for this period were missing.

runningSeconds

requiredinteger

seats

integer

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • at.happyproto.fleet.getTenantUsage

    query

    One tenant's metered usage by hour or day, with the hours that have no report. Proxied from the provisioner. Admin only.

  • at.happyproto.fleet.getCapacity

    query

    Store capacity: the latest totals, a daily trend, per-collection counts and what each tenant holds. Proxied from the provisioner. Admin only.

  • at.happyproto.fleet.getTenantIngestMetrics

    query

    How any tenant handled incoming records in a window, by collection and action. The same shape as server.getIngestMetrics. Admin only.

  • at.happyproto.fleet.getGrowth

    query

    Fleet and per-instance growth rates from instance_daily_deltas. Counter resets are excluded by the view, so a wiped volume lowers no rate. Admin only.

  • at.happyproto.server.getIngestMetrics

    query

    How one of the caller's own instances handled incoming records in a window, by collection and action. Customers only.